Facade::IUserInterfacePreferencesFacade Class Reference

Inheritance diagram for Facade::IUserInterfacePreferencesFacade:

Public Types
enum	{ kDefaultIID = IID_IUSERINTERFACEPREFERENCESFACADE }

Public Member Functions
virtual ErrorCode	SetToolboxOrientationPreference (IUserInterfacePreferences::ToolboxState newOrientation) const =0
virtual ErrorCode	SetToolTipPreference (IUserInterfacePreferences::TipsState newState) const =0
virtual ErrorCode	SetPaletteDrawerPreference (bool16 drawersStayOpen) const =0
virtual ErrorCode	SetAutoShowHiddenPanels (bool16 autoShow) const =0
virtual bool16	GetAutoShowHiddenPanels () const =0
virtual bool16	CanChangeUseApplicationFramePreference () const =0
virtual ErrorCode	SetUseApplicationFramePreference (bool16 useApplicationFrame) const =0
virtual bool16	GetUseApplicationFramePreference () const =0
virtual bool16	CanChangeShowAppBarPreference () const =0
virtual bool16	GetShowAppBarPreference () const =0
virtual ErrorCode	SetShowAppBarPreference (bool16 bShowAppBar) const =0
virtual bool16	GetOpenNewDocumentsInTabsPreference () const =0
virtual ErrorCode	SetOpenNewDocumentsInTabsPreference (bool16 openInTabs) const =0
virtual bool16	GetEnableFloatingPresentationDockingPreference () const =0
virtual ErrorCode	SetEnableFloatingPresentationDockingPreference (bool16 enableDocking) const =0
virtual ErrorCode	SetShowThumbnailCursorPreference (bool16 showThumbnailCursors) const =0
virtual bool16	GetShowThumbnailCursorPreference (void) const =0
virtual ErrorCode	SetUIShowObjectDimensionsCursor (bool16 showDimensions) const =0
virtual bool16	GetUIShowObjectDimensionsCursor () const =0
virtual ErrorCode	SetUIOpenRecentLengthPreference (int32 numOfOpenRecentFilesToDisplay) const =0
virtual int32	GetUIOpenRecentLengthPreference () const =0
virtual ErrorCode	SetUIPatientUserDelay (const int32 &milliseconds) const =0
virtual int32	GetUIPatientUserDelay (void) const =0
virtual ErrorCode	SetUIGrabberPanning (const IGrabberPrefs::PanningType grabberPanning) const =0
virtual IGrabberPrefs::PanningType	GetUIGrabberPanning (void) const =0
virtual ErrorCode	SetUIShowContentGrabber (bool16 show) const =0
virtual bool16	GetUIShowContentGrabber (void) const =0
virtual ErrorCode	SetUIShowLiveCorners (bool16 show) const =0
virtual bool16	GetUIShowLiveCorners (void) const =0
virtual ErrorCode	SetUIShowAnchorAdornment (bool16 show) const =0
virtual bool16	GetUIShowAnchorAdornment (void) const =0
virtual ErrorCode	SetShowMasterPageOverlay (bool16 show) const =0
virtual bool16	GetShowMasterPageOverlay (void) const =0
virtual ErrorCode	SetObjectsMoveWithPage (bool16 moveItemsWithPagesWithoutOptionKey) const =0
virtual bool16	GetObjectsMoveWithPage (void) const =0
virtual ErrorCode	SetEnableMultiTouchGesturesPreference (bool16 enableGestures) const =0
virtual bool16	GetEnableMultiTouchGesturesPreference () const =0
virtual ErrorCode	SetPreventSelectingLockedItems (bool16 show) const =0
virtual bool16	GetPreventSelectingLockedItems (void) const =0
virtual ErrorCode	SetObjectFrameHighlightingPreference (bool16 enableHighlighting) const =0
virtual bool16	GetObjectFrameHighlightingPreference () const =0
virtual ErrorCode	SetScrollAllWindows (bool16 scrollAll) const =0
virtual bool16	GetScrollAllWindows () const =0
virtual ErrorCode	SetZoomAllWindows (bool16 zoomAll) const =0
virtual bool16	GetZoomAllWindows () const =0
virtual ErrorCode	SetEnableDrawProxyOnDrag (bool16 enableDrawProxyOnDrag)=0
virtual bool16	GetEnableDrawProxyOnDrag () const =0
virtual ErrorCode	SetUIShowRibbon (bool16 show)=0
virtual bool16	GetUIShowRibbon (void) const =0
virtual ErrorCode	SetEnableCreateLinks (bool16 enableCreateLinks)=0
virtual bool16	GetEnableCreateLinks (void) const =0
virtual ErrorCode	SetEnableMapStyles (bool16 enableMapStyles)=0
virtual bool16	GetEnableMapStyles (void) const =0
virtual ErrorCode	SetUseCustomMonitorResolution (bool16 bUseCustomResolution) const =0
virtual bool16	GetUseCustomMonitorResolution () const =0
virtual ErrorCode	SetCustomMonitorResolution (const PMReal &ppi) const =0
virtual PMReal	GetCustomMonitorResolution () const =0
virtual ErrorCode	SetUIBrightnessPreference (const PMReal brightnessVal)=0
virtual PMReal	GetUIBrightnessPreference () const =0
virtual ErrorCode	SetPasteboardColorPreference (const int32 nPrefValue)=0
virtual int32	GetPasteboardColorPreference () const =0
virtual ErrorCode	SetShowWhatsNewOnStartup (bool16 showOnStartup)=0
virtual bool16	GetShowWhatsNewOnStartup () const =0
virtual ErrorCode	SetAutoAddSwatchToCCLibraries (bool16 addSwatchToCCLibraries)=0
virtual bool16	GetAutoAddSwatchToCCLibraries () const =0
virtual ErrorCode	SetAutoAddCharStyleToCCLibraries (bool16 addCharStyleToCCLibraries)=0
virtual bool16	GetAutoAddCharStyleToCCLibraries () const =0
virtual ErrorCode	SetAutoAddParaStyleToCCLibraries (bool16 addParaStyleToCCLibraries)=0
virtual bool16	GetAutoAddParaStyleToCCLibraries () const =0
virtual ErrorCode	SetShowHomeWorkspace (bool16 show)=0
virtual bool16	GetShowHomeWorkspace () const =0
virtual ErrorCode	SetUIShowStockPurchaseAdornment (bool16 show) const =0
virtual bool16	GetUIShowStockPurchaseAdornment (void) const =0
virtual ErrorCode	SetPanelTabHeightPreference (bool16 tabHeight) const =0
virtual bool16	GetPanelTabHeightPreference (void) const =0
virtual ErrorCode	SetShowLegacyNewDocDlg (bool16 show)=0
virtual bool16	GetShowLegacyNewDocDlg () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual bool16 Facade::IUserInterfacePreferencesFacade::CanChangeShowAppBarPreference ( ) const

pure virtual

Return whether this preference can be set. Always false on Win since app bar is always visible. True on Mac when container/frame mode is turned off.

See Also

GetUseApplicationFramePreference

Returns

true if App Bar show/hide setting can be changed, false if not

virtual bool16 Facade::IUserInterfacePreferencesFacade::CanChangeUseApplicationFramePreference ( ) const

pure virtual

Return whether this preference can be set. Always false on Win since app frame is always on. True on Mac.

Returns

true if Application frame setting can be changed, false if not

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetAutoAddCharStyleToCCLibraries ( ) const

pure virtual

Get whether to add the new char style(created through the new char style dialog) to CC Libraries automatically

Returns

bool16 if kTrue the new char style created using the new char style dialog will be added to CC Libraries automatically.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetAutoAddParaStyleToCCLibraries ( ) const

pure virtual

Get whether to add the new para style(created through the new para style dialog) to CC Libraries automatically

Returns

bool16 if kTrue the new para style created using the new para style dialog will be added to CC Libraries automatically.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetAutoAddSwatchToCCLibraries ( ) const

pure virtual

Get whether to add the new swatch(created through the new swatch dialog) to CC Libraries automatically

Returns

bool16 if kTrue the new swatch created using the new swatch dialog will be added to CC Libraries automatically.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetAutoShowHiddenPanels ( ) const

pure virtual

Get the current UI Panel auto show hidden panels (when the panel UI is tabbed away) preference

Returns

true if hidden panels auto show when mouse is over the the vertical reveal strip (if false, the vertical reveal strips are not drawn)

virtual PMReal Facade::IUserInterfacePreferencesFacade::GetCustomMonitorResolution ( ) const

pure virtual

Get the custom monitor resolution to use when GetUseCustomMonitorResolution() returns kTrue

Returns

The pixels per inch value to use for the monitor resolution

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetEnableCreateLinks ( void  ) const

pure virtual

Get the preference for enabling links creation.

Returns

kTrue if setting is enabled.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetEnableDrawProxyOnDrag ( ) const

pure virtual

Get the preference for enabling proxy drawing when dragging vector graphics at high quality.

Returns

kTrue if setting is enabled.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetEnableFloatingPresentationDockingPreference ( ) const

pure virtual

Get the preference for allowing user to drag floating presentations to dock to create tabs.

Returns

kTrue if docking is allowed, kFalse if not allowed

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetEnableMapStyles ( void  ) const

pure virtual

Get the preference for enabling mapping of styles.

Returns

kTrue if setting is enabled.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetEnableMultiTouchGesturesPreference ( ) const

pure virtual

Get the preference for allowing multi-touch gestures.

Returns

kTrue if multi-touch gestures are allowed.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetObjectFrameHighlightingPreference ( ) const

pure virtual

Get the preference for enabling highlighting of object frames under selection tool.

Returns

kTrue if highlighting is enabled.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetObjectsMoveWithPage ( void  ) const

pure virtual

Get the current preference for whether page items move when a page is repositioned from the UI.

Returns

bool16 returns whether page items move without the option key held down

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetOpenNewDocumentsInTabsPreference ( ) const

pure virtual

Return the OpenNewDocumentsInTabs preference

Returns

bool16 if new documents should open in a tab, kFalse if open as a new floating window.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetPanelTabHeightPreference ( void  ) const

pure virtual

  Gets the current preference for showing the tab height of the panel.

Returns

kTrue if large tabs are supported else returns kFalse.

virtual int32 Facade::IUserInterfacePreferencesFacade::GetPasteboardColorPreference ( ) const

pure virtual

Get the Pasteboard color Preference value

Returns

the Pasteboard color preference Value

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetPreventSelectingLockedItems ( void  ) const

pure virtual

Get the current preference for preventing selection of locked items.

Returns

bool16 kTrue if you can't select an locked item, kFalse if you can select them.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetScrollAllWindows ( ) const

pure virtual

Get the preference for scrolling all document windows when using the hand tool.

Returns

kTrue if scrolling across document windows is enabled.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetShowAppBarPreference ( ) const

pure virtual

Return the preference for whether the App Bar is showing or not. Always true on Win.

Returns

true if App Bar is showing, kFalse if hidden

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetShowHomeWorkspace ( ) const

pure virtual

Get whether to show CCX Home workspace in no document state

Returns

bool16 kTrue if CCX Home workspace in no document state, kFalse otherwise.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetShowLegacyNewDocDlg ( ) const

pure virtual

Get whether to show legacy New Document Dialog

Returns

bool16 kTrue if legacy New Document Dialog, kFalse otherwise.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetShowMasterPageOverlay ( void  ) const

pure virtual

Get the current preference for showing the master page overlay for a Page Tool selection.

Returns

bool16 kTrue if the master page overlay should be shown, kFalse if hidden.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetShowThumbnailCursorPreference ( void  ) const

pure virtual

Returns

Whether or not the place cursor will draw as a thumbnail of the imported file.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetShowWhatsNewOnStartup ( ) const

pure virtual

Get whether "What's New" dialog is to be shown on startup.

Returns

bool16 kTrue if "What's New" dialog should be shown on startup, kFalse otherwise.

virtual PMReal Facade::IUserInterfacePreferencesFacade::GetUIBrightnessPreference ( ) const

pure virtual

Get the Preference Value for User Interface brightness

Returns

brightness Value

virtual IGrabberPrefs::PanningType Facade::IUserInterfacePreferencesFacade::GetUIGrabberPanning ( void  ) const

pure virtual

Get the current preference for grabber hand panning display quality.

Returns

IGrabberPrefs::PanningType enum value.

See Also

IGrabberPrefs.h for enum values, kFullDrawPanning, kFastDrawPanning, or kNoDrawPanning.

virtual int32 Facade::IUserInterfacePreferencesFacade::GetUIOpenRecentLengthPreference ( ) const

pure virtual

Get the current UI Open Recent Length preference. Users

may wish to increase or decrease this value to show more or less files in the Open Recent submenu.

Returns

number of items to show in the Open Recent submenu.

virtual int32 Facade::IUserInterfacePreferencesFacade::GetUIPatientUserDelay ( void  ) const

pure virtual

Get the current preference for patient user delay. Users may wish to turn off or on this setting based on performance or display issues.

Returns

int32 delay value in milliseconds.

See Also

IPatientUserPreference.h for typical values.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetUIShowAnchorAdornment ( void  ) const

pure virtual

Get the current preference for showing the anchor adornment on objects.

Returns

bool16 kTrue if anchor adornment should be shown, kFalse if hidden.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetUIShowContentGrabber ( void  ) const

pure virtual

Get the current preference for showing the content grabber adornment.

Returns

bool16 kTrue if grabber should be shown, kFalse if hidden.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetUIShowLiveCorners ( void  ) const

pure virtual

Get the current preference for showing the live corners adornment on splines.

Returns

bool16 kTrue if live corners adornment should be shown, kFalse if hidden.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetUIShowObjectDimensionsCursor ( ) const

pure virtual

Get the current UI "Show Object Dimensions" cursor option preference. Users may wish to turn this preference off if their computer is connected remotely via something like Remote Desktop.

Returns

true if the width/height, x/y position or rotation angle of a page item is displayed in the cursor while editing a page item.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetUIShowRibbon ( void  ) const

pure virtual

Get the current preference for showing the ribbon.

Returns

bool16 kTrue if ribbon should be shown, kFalse if hidden.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetUIShowStockPurchaseAdornment ( void  ) const

pure virtual

  Get the current preference for showing the stock purchase adornment on unlicensed stock images.

Returns

bool16 kTrue if stock purchase adornment should be shown, kFalse if hidden.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetUseApplicationFramePreference ( ) const

pure virtual

Get the UseApplicationFrame preference

Returns

kTrue if application frame is turned on, kFalse if off.

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetUseCustomMonitorResolution ( ) const

pure virtual

Get whether to use a custom monitor resolution (kTrue) or determine it from system settings (kFalse).

Returns

kTrue to use the custom setting, kFalse to use system settings

virtual bool16 Facade::IUserInterfacePreferencesFacade::GetZoomAllWindows ( ) const

pure virtual

Get the preference for zooming all document windows when using the zoom tool.

Returns

kTrue if zooming across document windows is enabled.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetAutoAddCharStyleToCCLibraries ( bool16  addCharStyleToCCLibraries )

pure virtual

Set whether to add the new char style(created through the new char style dialog) to CC Libraries automatically

Parameters

addAddCharStyleToCCLibraries

[IN], if kTrue the new char style created using the new char style dialog will be added to CC Libraries automatically.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetAutoAddParaStyleToCCLibraries ( bool16  addParaStyleToCCLibraries )

pure virtual

Set whether to add the new para style(created through the new para style dialog) to CC Libraries automatically

Parameters

addParaStyleToCCLibraries

[IN], if kTrue the new para style created using the new para style dialog will be added to CC Libraries automatically.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetAutoAddSwatchToCCLibraries ( bool16  addSwatchToCCLibraries )

pure virtual

Set whether to add the new swatch(created through the new swatch dialog) to CC Libraries automatically

Parameters

addSwatchToCCLibraries

[IN], if kTrue the new swatch created using the new swatch dialog will be added to CC Libraries automatically.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetAutoShowHiddenPanels ( bool16  autoShow ) const

pure virtual

Set the auto show hidden panels preference

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetCustomMonitorResolution ( const PMReal &  ppi ) const

pure virtual

Set the custom monitor resolution to use when GetUseCustomMonitorResolution() returns kTrue

Parameters

ppi	[IN] The pixels per inch value to use for the monitor resolution

Returns

ErrorCode

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetEnableCreateLinks ( bool16  enableCreateLinks )

pure virtual

Set the preference for enabling links creation.

Parameters

enableCreateLinks

[IN]: true to enable setting, false to disable.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetEnableDrawProxyOnDrag ( bool16  enableDrawProxyOnDrag )

pure virtual

Set the preference for enabling proxy drawing when dragging vector graphics at high quality.

Parameters

enableDrawProxyOnDrag

[IN]: true to enable setting, false to disable.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetEnableFloatingPresentationDockingPreference ( bool16  enableDocking ) const

pure virtual

Set the preference for allowing user to drag floating presentations to dock to create tabs.

Parameters

enableDocking

[IN]: true to allow dragging to create tabs, false to disallow.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetEnableMapStyles ( bool16  enableMapStyles )

pure virtual

Set the preference for enabling mapping of styles.

Parameters

enableCreateLinks

[IN]: true to enable setting, false to disable.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetEnableMultiTouchGesturesPreference ( bool16  enableGestures ) const

pure virtual

Set the preference for allowing multi-touch gestures.

Parameters

enableGestures

[IN]: true to allow multi-touch gestures, false to disallow.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetObjectFrameHighlightingPreference ( bool16  enableHighlighting ) const

pure virtual

Set the preference for enabling highlighting of object frames under selection tool.

Parameters

enableHighlighting

[IN]: true to enable highlighting, false to disable.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetObjectsMoveWithPage ( bool16  moveItemsWithPagesWithoutOptionKey ) const

pure virtual

Set the current preference for whether page items move when a page is repositioned from the UI.

Parameters

moveItemsWithPagesWithoutOptionKey

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetOpenNewDocumentsInTabsPreference ( bool16  openInTabs ) const

pure virtual

Set the OpenNewDocumentsInTabs preference

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetPaletteDrawerPreference ( bool16  drawersStayOpen ) const

pure virtual

Set the palette drawer preference

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetPanelTabHeightPreference ( bool16  tabHeight ) const

pure virtual

  Sets the current preference for showing the tab height of the panel.

Parameters

tabHeight,kTrue

if large panel tab height is to be supported else kFalse.

Returns

kSuccess if the Panel Tab Height Preference is successfully changed else return an errorcode.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetPasteboardColorPreference ( const int32  nPrefValue )

pure virtual

Set the Pasteboard color Preference value

Parameters

nPrefValue

[IN], specify specify the Pasteboard color preference

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetPreventSelectingLockedItems ( bool16  show ) const

pure virtual

Set the current preference for preventing selection of locked items.

Parameters

show,kTrue

if you can't select an locked item, kFalse if you can select them.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetScrollAllWindows ( bool16  scrollAll ) const

pure virtual

Get the preference for scrolling all document windows when using the hand tool.

Parameters

scrollAll

[IN]: true to enable scrolling across document windows, false to disable.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetShowAppBarPreference ( bool16  bShowAppBar ) const

pure virtual

Set the preference for whether the App Bar shows or not. Setting to false has no effect on Windows.

Parameters

bShowAppBar

[IN]: kTrue to show App Bar, kFalse to hide.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetShowHomeWorkspace ( bool16  show )

pure virtual

Set whether to show CCX Home workspace in no document state

Parameters

show	[IN], kTrue to show CCX Home workspace in no document state

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetShowLegacyNewDocDlg ( bool16  show )

pure virtual

Set whether to show legacy New Document Dialog

Parameters

show	[IN], kTrue to show legacy New Document Dialog

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetShowMasterPageOverlay ( bool16  show ) const

pure virtual

Set the current preference for showing the master page overlay for a Page Tool selection.

Parameters

show,kTrue

to show the master page overlay, kFalse to hide.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetShowThumbnailCursorPreference ( bool16  showThumbnailCursors ) const

pure virtual

Set the current UI "Show Thumbnails Cursor" preference. Users may wish to turn this preference off if their computer is connected remotely via something like Remote Desktop.

Parameters

showThumbnailCursors

[IN]: true to draw the Place cursor as a thumbnail of the imported file.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetShowWhatsNewOnStartup ( bool16  showOnStartup )

pure virtual

Set whether to show "What's New" dialog on startup.

Parameters

showOnStartup

[IN], kTrue if "What's New" dialog should be shown on startup, kFalse otherwise.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetToolboxOrientationPreference ( IUserInterfacePreferences::ToolboxState  newOrientation ) const

pure virtual

Set the toolbox orientation

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetToolTipPreference ( IUserInterfacePreferences::TipsState  newState ) const

pure virtual

Set the tooltip preference

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUIBrightnessPreference ( const PMReal  brightnessVal )

pure virtual

Set the Preference for User Interface brightness

Parameters

brightnessVal

[IN], this value varies form 0.0 (for Darkest) to 1.0 (for Brightest). Specify 1.0 for Bright, 0.67 for Medium Bright, 0.33 for medium dark, and 0.0 for Dark. Any intermediate value between 0.0 and 1.0 can also be specified.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUIGrabberPanning ( const IGrabberPrefs::PanningType  grabberPanning ) const

pure virtual

Set the current preference for grabber hand display quality.

Parameters

grabberPanning,enum

value for panning drawing when using grabber hand.

Returns

kSuccess if the preference is successfully changed, else an error code.

See Also

IGrabberPrefs.h for enum values, kFullDrawPanning, kFastDrawPanning, or kNoDrawPanning.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUIOpenRecentLengthPreference ( int32  numOfOpenRecentFilesToDisplay ) const

pure virtual

Set the current UI Open Recent Length preference. Users

may wish to increase or decrease this value to show more or less files in the Open Recent submenu.

Parameters

numOfOpenRecentFilesToDisplay

[IN]: number of Open Recent files to display. Must be from 1 to 30.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUIPatientUserDelay ( const int32 &  milliseconds ) const

pure virtual

Set the current preference for patient user delay. Users may wish to turn off or on this setting based on performance or display issues.

Parameters

milliseconds,delay

value in milliseconds. Range kMinPatientUserDelay to kMaxPatientUserDelay.

Returns

kSuccess if the preference is successfully changed, else an error code.

See Also

IPatientUserPreference.h for typical values and limits.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUIShowAnchorAdornment ( bool16  show ) const

pure virtual

Set the current preference for showing the anchor adornment on objects. This adornment allows the pointer tool to click and drag to anchor to text or with shift pressed created an inline.

Parameters

show,kTrue

to show the anchor adornment, kFalse to hide.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUIShowContentGrabber ( bool16  show ) const

pure virtual

Set the current preference for showing the content grabber adornment. This adornment allows the pointer tool to select spline content when clicking on the "donut" adornment.

Parameters

show,kTrue

to show the content grabber adornment, kFalse to hide.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUIShowLiveCorners ( bool16  show ) const

pure virtual

Set the current preference for showing the live corners adornment on splines. This adornment allows the pointer tool to edit corner radii when clicked on.

Parameters

show,kTrue

to show the live corners adornment, kFalse to hide.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUIShowObjectDimensionsCursor ( bool16  showDimensions ) const

pure virtual

Set the current UI "Show Thumbnails Cursor" preference. Users may wish to turn this preference off if their computer is connected

Parameters

showDimensions

[IN]: true to the width/height, x/y position or rotation angle of a page item in the cursor while editing a page item.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUIShowRibbon ( bool16  show )

pure virtual

Set the current preference for showing the ribbon.

Parameters

show	[IN]: kTrue to show the ribbon, kFalse to hide.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUIShowStockPurchaseAdornment ( bool16  show ) const

pure virtual

 Set the current preference for showing the stock purchase adornment on unlicensed stock images.

This adornment allows the pointer tool to click and open the license extension and proceed with in app licensing workflow.

Parameters

show,kTrue

to show the stock purchase adornment, kFalse to hide.

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUseApplicationFramePreference ( bool16  useApplicationFrame ) const

pure virtual

Set the UseApplicationFrame preference

Returns

kSuccess if the preference is successfully changed, else an error code.

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetUseCustomMonitorResolution ( bool16  bUseCustomResolution ) const

pure virtual

Set whether to use a custom monitor resolution (kTrue) or determine it from system settings (kFalse).

Parameters

bUseCustomResolution

[IN] kTrue to use the custom setting, kFalse to use system settings

Returns

ErrorCode

virtual ErrorCode Facade::IUserInterfacePreferencesFacade::SetZoomAllWindows ( bool16  zoomAll ) const

pure virtual

Get the preference for zooming all document windows when using the zoom tool.

Parameters

zoomAll

[IN]: true to enable zooming across document windows, false to disable.

Returns

kSuccess if the preference is successfully changed, else an error code.