IFullScreenRestoreData Class Reference

#include <IFullScreenRestoreData.h>

Inheritance diagram for IFullScreenRestoreData:

Public Types
enum	{ kDefaultIID = IID_IFULLSCREENRESTOREDATA }

Public Member Functions
virtual void	SetRestoreMargins (const PMRect &margins)=0
virtual PMRect	GetRestoreMargins ()=0
virtual void	ClearHiddenWidgetList ()=0
virtual void	AddHiddenWidget (WidgetID widgetID)=0
virtual int32	GetHiddenWidgetCount () const =0
virtual WidgetID	GetHiddenWidgetID (int32 at)=0
virtual void	SetRestoreScreenMode (IPreviewPrefs::PreviewMode mode)=0
virtual IPreviewPrefs::PreviewMode	GetRestoreScreenMode ()=0
virtual void	SetRestoreStructure (bool16 structureShown)=0
virtual bool16	GetRestoreStructure ()=0
virtual void	SetRestoreSplitLayout (bool16 splitLayout)=0
virtual bool16	GetRestoreSplitLayout ()=0
virtual void	SetRestoreFit (ILayoutControlData::FitSetting fit)=0
virtual ILayoutControlData::FitSetting	GetRestoreFit ()=0
virtual void	SetRestoreBGColorIndex (int32 bgColorIndex)=0
virtual int32	GetRestoreBGColorIndex ()=0
virtual void	SetRestoreDrawOptions (int32 drawOptions)=0
virtual int32	GetRestoreDrawOptions ()=0
virtual void	SetRestoreZoom (PMReal zoom)=0
virtual PMReal	GetRestoreZoom ()=0
virtual void	SetAutoShowHiddenPanels (bool16 autoShow)=0
virtual bool16	GetAutoShowHiddenPanels ()=0
virtual void	SetIsPresentationMode (bool16 isPresentationMode)=0
virtual bool16	IsPresentationMode ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Data used to restore the state of the document window when exiting full screen mode.

Member Function Documentation

virtual void IFullScreenRestoreData::AddHiddenWidget ( WidgetID  widgetID )

pure virtual

Add a WidgetID of a widget we are hiding as we enter full screen mode.

Parameters

WidgetID

ID of the widget

virtual void IFullScreenRestoreData::ClearHiddenWidgetList ( )

pure virtual

Clear the hidden widget list.

virtual bool16 IFullScreenRestoreData::GetAutoShowHiddenPanels ( )

pure virtual

Get the state of the auto restore hidden panels to be restored when we exit full screen

Returns

bool16 true if structure was showing

virtual int32 IFullScreenRestoreData::GetHiddenWidgetCount ( ) const

pure virtual

Get the resources plugin id for the widget.

virtual WidgetID IFullScreenRestoreData::GetHiddenWidgetID ( int32  at )

pure virtual

Get the WidgetID of a hidden widget.

Parameters

at	index of hidden widget you want the ID for.

virtual int32 IFullScreenRestoreData::GetRestoreBGColorIndex ( )

pure virtual

Get the background color index to be restored when we exit full screen

Returns

index of the preview background color to restore

virtual int32 IFullScreenRestoreData::GetRestoreDrawOptions ( )

pure virtual

Get the draw options to be restored when we exit full screen

Returns

IDrawOptions::* to restore

virtual ILayoutControlData::FitSetting IFullScreenRestoreData::GetRestoreFit ( )

pure virtual

Get the screen mode to be restored when we exit full screen

Returns

ILayoutControlData::FitSetting mode

virtual PMRect IFullScreenRestoreData::GetRestoreMargins ( )

pure virtual

Gets the margins for the frame of the SplitterPanelWidget.

Returns

PMRect for the margins

virtual IPreviewPrefs::PreviewMode IFullScreenRestoreData::GetRestoreScreenMode ( )

pure virtual

Get the screen mode to be restored when we exit full screen

Returns

IPreviewPrefs::PreviewMode screen mode

virtual bool16 IFullScreenRestoreData::GetRestoreSplitLayout ( )

pure virtual

Get the state of the split layout pane to be restored when we exit full screen

Returns

bool16 true if split layout was showing

virtual bool16 IFullScreenRestoreData::GetRestoreStructure ( )

pure virtual

Get the state of the structure pane to be restored when we exit full screen

Returns

bool16 true if structure was showing

virtual PMReal IFullScreenRestoreData::GetRestoreZoom ( )

pure virtual

Get the draw options to be restored when we exit full screen

Returns

PMReal zoom level to restore

virtual bool16 IFullScreenRestoreData::IsPresentationMode ( )

pure virtual

returns true if we are in PresentationMode. We need to know this since windows can be in full screen, but not in presentation mode.

Returns

true if in presentation mode, false otherwise

virtual void IFullScreenRestoreData::SetAutoShowHiddenPanels ( bool16  autoShow )

pure virtual

Set the current state of the auto restore hidden panels to be restored when we exit full screen

Parameters

structureShown

true if structure was showing

virtual void IFullScreenRestoreData::SetIsPresentationMode ( bool16  isPresentationMode )

pure virtual

Sets flag to indicate that we are in PresentationMode. We need to know this since windows can be in full screen, but not in presentation mode. This should be set after presentation mode is started and cleared after it's done.

Parameters

isPresentationMode

true if in presentation mode, false otherwise

virtual void IFullScreenRestoreData::SetRestoreBGColorIndex ( int32  bgColorIndex )

pure virtual

Set the current background color to be restored when we exit full screen

Parameters

bgColorIndex

color index of the preview background color

virtual void IFullScreenRestoreData::SetRestoreDrawOptions ( int32  drawOptions )

pure virtual

Set the current draw options to be restored when we exit full screen

Parameters

drawOptions

color index of the preview background color

virtual void IFullScreenRestoreData::SetRestoreFit ( ILayoutControlData::FitSetting  fit )

pure virtual

Set the current fit mode to be restored when we exit full screen

Parameters

fit	ILayoutControlData::FitSetting mode

virtual void IFullScreenRestoreData::SetRestoreMargins ( const PMRect &  margins )

pure virtual

Set the rect of the frame of the LayoutPanelWidget.

Parameters

margins

values for the SplitterPanelWidget prior to entering full screen mode

virtual void IFullScreenRestoreData::SetRestoreScreenMode ( IPreviewPrefs::PreviewMode  mode )

pure virtual

Set the current screen mode to be restored when we exit full screen

Parameters

mode	IPreviewPrefs::PreviewMode screen mode

virtual void IFullScreenRestoreData::SetRestoreSplitLayout ( bool16  splitLayout )

pure virtual

Set the current state of the split layout pane to be restored when we exit full screen

Parameters

splitLayout

true if split layout was shown

virtual void IFullScreenRestoreData::SetRestoreStructure ( bool16  structureShown )

pure virtual

Set the current state of the structure pane to be restored when we exit full screen

Parameters

structureShown

true if structure was showing

virtual void IFullScreenRestoreData::SetRestoreZoom ( PMReal  zoom )

pure virtual

Set the current zoom level to be restored when we exit full screen (if there is no specific fit option)

Parameters

zoom

level