![]() | InDesign SDK 20.5 |
#include <IUserInterfacePreferences.h>

Public Types | |
| enum | { kDefaultIID = IID_IUSERINTERFACEPREFERENCES } |
| enum | ToolboxState { kTallSkinny = 0, kTallRegular, kWideSkinny } |
| enum | TipsState { kNoTips = 0, kNormalTips, kSlowTips, kFastTips } |
| enum | UIBrightnessPreference { kBrightUI = 0, kMediumBrightUI, kMediumDarkUI, kDarkUI, kCustomUI } |
| enum | PasteboardColorPreference { kPasteboardWhiteColored = 0, kPasteboardThemeColored } |
Public Member Functions | |
| virtual ToolboxState | GetToolboxOrientation () const =0 |
| virtual void | SetToolboxOrientation (ToolboxState newOrientation)=0 |
| virtual TipsState | GetTipsState () const =0 |
| virtual void | SetTipsState (TipsState newState)=0 |
| virtual bool16 | GetUIPaletteDrawersStayOpen () const =0 |
| virtual void | SetUIPaletteDrawersStayOpen (bool16 drawersStayOpen)=0 |
| virtual bool16 | GetUIAutoShowHiddenPanels () const =0 |
| virtual void | SetUIAutoShowHiddenPanels (bool16 autoShow)=0 |
| virtual bool16 | GetUseApplicationContainerAsAppFrame () const =0 |
| virtual void | SetUseApplicationContainerAsAppFrame (bool16 iWantToLiveInABox)=0 |
| virtual bool16 | GetShowAppBar () const =0 |
| virtual void | SetShowAppBar (bool16 bShowAppBar)=0 |
| virtual bool16 | GetNewPresentationsAppearAsNewTabInActiveContext () const =0 |
| virtual void | SetNewDocumentPresentationsAppearAsNewTabInActiveContext (bool16 createNewDocumentTabs)=0 |
| virtual bool16 | GetEnableFloatingPresentationDocking () const =0 |
| virtual void | SetEnableFloatingPresentationDocking (bool16 enableDocking)=0 |
| virtual bool16 | GetUIShowThumbnailCursor () const =0 |
| virtual void | SetUIShowThumbnailCursor (bool16 showThumbnails)=0 |
| virtual bool16 | GetUIShowObjectDimensionsCursor () const =0 |
| virtual void | SetUIShowObjectDimensionsCursor (bool16 showDimensions)=0 |
| virtual int32 | GetUIOpenRecentLength () const =0 |
| virtual void | SetUIOpenRecentLength (int32 numOfOpenRecentFilesToDisplay)=0 |
| virtual bool16 | GetUIShowContentGrabber (void) const =0 |
| virtual void | SetUIShowContentGrabber (bool16 show)=0 |
| virtual bool16 | GetUIShowLiveCorners (void) const =0 |
| virtual void | SetUIShowLiveCorners (bool16 show)=0 |
| virtual bool16 | GetUIShowAnchorAdornment (void) const =0 |
| virtual void | SetUIShowAnchorAdornment (bool16 show)=0 |
| virtual bool16 | GetShowMasterPageOverlay (void) const =0 |
| virtual void | SetShowMasterPageOverlay (bool16 show)=0 |
| virtual bool16 | GetObjectsMoveWithPage (void) const =0 |
| virtual void | SetObjectsMoveWithPage (bool16 moveItemsWithPagesWithoutOptionKey)=0 |
| virtual bool16 | GetEnableMultiTouchGestures () const =0 |
| virtual void | SetEnableMultiTouchGestures (bool16 enableGestures)=0 |
| virtual bool16 | GetPreventSelectingLockedItems (void) const =0 |
| virtual void | SetPreventSelectingLockedItems (bool16 show)=0 |
| virtual bool16 | GetObjectFrameHighlighting () const =0 |
| virtual void | SetObjectFrameHighlighting (bool16 enableHighlighting)=0 |
| virtual bool16 | GetScrollAllWindows () const =0 |
| virtual void | SetScrollAllWindows (bool16 scrollAll)=0 |
| virtual bool16 | GetZoomAllWindows () const =0 |
| virtual void | SetZoomAllWindows (bool16 zoomAll)=0 |
| virtual bool16 | GetEnableDrawProxyOnDrag () const =0 |
| virtual void | SetEnableDrawProxyOnDrag (bool16 enableDrawProxyOnDrag)=0 |
| virtual bool16 | GetUIShowRibbon (void) const =0 |
| virtual void | SetUIShowRibbon (bool16 show)=0 |
| virtual bool16 | GetEnableCreateLinks (void) const =0 |
| virtual void | SetEnableCreateLinks (bool16 enableCreateLinks)=0 |
| virtual bool16 | GetEnableMapStyles (void) const =0 |
| virtual void | SetEnableMapStyles (bool16 enableMapStyles)=0 |
| virtual void | SetUseCustomMonitorResolution (bool16 bUseCustomResolution)=0 |
| virtual bool16 | GetUseCustomMonitorResolution () const =0 |
| virtual void | SetCustomMonitorResolution (const PMReal &ppi)=0 |
| virtual PMReal | GetCustomMonitorResolution () const =0 |
| virtual void | SetUIBrightnessPreference (const PMReal brightnessVal)=0 |
| virtual PMReal | GetUIBrightnessPreference () const =0 |
| virtual void | SetPasteboardColorPreference (const int32 nPrefValue)=0 |
| virtual int32 | GetPasteboardColorPreference () const =0 |
| virtual void | SetShowWhatsNewOnStartup (bool16 showOnStartup)=0 |
| virtual bool16 | GetShowWhatsNewOnStartup () const =0 |
| virtual void | SetAutoAddSwatchToCCLibraries (bool16 addSwatchToCCLibraries)=0 |
| virtual bool16 | GetAutoAddSwatchToCCLibraries () const =0 |
| virtual void | SetAutoAddCharStyleToCCLibraries (bool16 addCharStyleToCCLibraries)=0 |
| virtual bool16 | GetAutoAddCharStyleToCCLibraries () const =0 |
| virtual void | SetAutoAddParaStyleToCCLibraries (bool16 addParaStyleToCCLibraries)=0 |
| virtual bool16 | GetAutoAddParaStyleToCCLibraries () const =0 |
| virtual void | EnableApplicationContainerAsAppFrame ()=0 |
| virtual void | SetShowHomeWorkspace (bool16 show)=0 |
| virtual bool16 | GetShowHomeWorkspace () const =0 |
| virtual bool16 | GetUIShowStockPurchaseAdornment (void) const =0 |
| virtual void | SetUIShowStockPurchaseAdornment (bool16 show)=0 |
| virtual bool16 | GetPanelTabHeightPreference (void) const =0 |
| virtual void | SetPanelTabHeightPreference (bool16 tabHeight)=0 |
| virtual void | 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 |
Static Public Attributes | |
| static PMReal | UIBrightnessPreferenceValue [] |
Interface responsible for maintaining user interface preferences.
ToolboxState returned by GetToolboxOrientation().
| Enumerator | |
|---|---|
| kTallSkinny | kTallSkinny is the single column toolbox. |
| kTallRegular | kTallRegular is the default 2 column toolbox. |
| kWideSkinny | kWideSkinny is the single row toolbox. |
| pure virtual |
for internal use only Set the preference for ApplicationContainer functions as an ApplicationFrame
| pure virtual |
Get whether to add the new char style(created through the new char style dialog) to CC Libraries automatically
| pure virtual |
Get whether to add the new para style(created through the new para style dialog) to CC Libraries automatically
| pure virtual |
Get whether to add the new swatch(created through the new swatch dialog) to CC Libraries automatically
| pure virtual |
Get the custom monitor resolution to use when GetUseCustomMonitorResolution() returns kTrue
| pure virtual |
Get the current preference for enabling the creation of links.
| pure virtual |
Get the preference for enabling proxy drawing when dragging vector graphics at high quality.
| pure virtual |
Get the current UI preference for allowing user to drag floating presentations to dock to create tabs.
| pure virtual |
Get the current preference for enabling the mapping of style.
| pure virtual |
Get the preference for allowing multi-touch gestures.
| pure virtual |
Get the preference for where to put a newly opened document presentation.
| pure virtual |
Get the preference for enabling highlighting of object frames under selection tool.
| pure virtual |
Get the current preference for whether page items move when a page is repositioned from the UI.
| pure virtual |
Get the current preference for Panel Tab Height.
| pure virtual |
Get the Pasteboard color Preference value
| pure virtual |
Get the current preference for preventing selection of locked items.
| pure virtual |
Get the preference for scrolling all document windows when using the hand tool.
| pure virtual |
Return the preference for whether the App Bar is showing or not. Always true on Win.
| pure virtual |
Get whether to show CCX Home workspace in no document state
| pure virtual |
Get whether to show legacy New Document Dialog
| pure virtual |
Get the current preference for showing the master page overlay for a Page Tool selection.
| pure virtual |
Get whether "What's New" dialog is to be shown on startup.
| pure virtual |
Get the current tips preference
| pure virtual |
Get the current toolbox preference
| pure virtual |
Get the current UI Panel auto show hidden panels (when the panel UI is tabbed away) preference
| pure virtual |
Get the Preference Value for User Interface brightness
| 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.
| pure virtual |
Get the current UI Palette drawer persistence preference
| pure virtual |
Get the current preference for showing the anchor adornment on objects.
| pure virtual |
Get the current preference for showing the content grabber adornment.
| pure virtual |
Get the current preference for showing the live corners adornment on splines.
| 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.
| pure virtual |
Get the current preference for showing the ribbon.
| pure virtual |
Get the current preference for showing the stock purchase adornment on unlicensed stock images.
| pure virtual |
Get 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.
| pure virtual |
Return the preference for whether the ApplicationContainer functions as an ApplicationFrame. Always true on Win.
| pure virtual |
Get whether to use a custom monitor resolution (kTrue) or determine it from system settings (kFalse).
| pure virtual |
Get the preference for zooming all document windows when using the zoom tool.
| pure virtual |
Set whether to add the new char style(created through the new char style dialog) to CC Libraries automatically
| addAddCharStyleToCCLibraries | [IN], if kTrue the new char style created using the new char style dialog will be added to CC Libraries automatically. |
| pure virtual |
Set whether to add the new para style(created through the new para style dialog) to CC Libraries automatically
| addParaStyleToCCLibraries | [IN], if kTrue the new para style created using the new para style dialog will be added to CC Libraries automatically. |
| pure virtual |
Set whether to add the new swatch(created through the new swatch dialog) to CC Libraries automatically
| addSwatchToCCLibraries | [IN], if kTrue the new swatch created using the new swatch dialog will be added to CC Libraries automatically. |
| pure virtual |
Set the custom monitor resolution to use when GetUseCustomMonitorResolution() returns kTrue
| ppi | [IN] The pixels per inch value to use for the monitor resolution |
| pure virtual |
Set the current preference for enabling the creation of links.
| show,kTrue | to enable the link creation, kFalse to hide. |
| pure virtual |
Set the preference for enabling proxy drawing when dragging vector graphics at high quality.
| enableDrawProxyOnDrag | [IN]: true to enable setting, false to disable. |
| pure virtual |
Set the current UI preference for allowing user to drag floating presentations to dock to create tabs.
| enableDocking | [IN]: true to allow dragging to create tabs, false to disallow. |
| pure virtual |
Set the current preference for enabling the mapping of style.
| show,kTrue | to enable the mapping of styles, kFalse to hide. |
| pure virtual |
Set the preference for allowing multi-touch gestures.
| enableGestures | [IN]: true to allow multi-touch gestures, false to disallow. |
| pure virtual |
Set the preference for where to put a newly opened document presentation.
| drawersStayOpen | [IN]: true to make palette drawers stay open. |
| pure virtual |
Set the preference for enabling highlighting of object frames under selection tool.
| enableHighlighting | [IN]: true to enable highlighting, false to disable. |
| pure virtual |
Set the current preference for whether page items move when a page is repositioned from the UI.
| moveItemsWithPagesWithoutOptionKey |
| pure virtual |
Set the current preference for the Panel Tab Height.
| tabHeight,kTrue | for large tab height else kFalse if small Tabs are supported for Panels. |
| pure virtual |
Set the Pasteboard color Preference value
| nPrefValue | [IN], specify the paper color preference |
| pure virtual |
Set the current preference for preventing selection of locked items.
| show,kTrue | if you can't select an locked item, kFalse if you can select them. |
| pure virtual |
Get the preference for scrolling all document windows when using the hand tool.
| scrollAll | [IN]: true to enable scrolling across document windows, false to disable. |
| pure virtual |
Set the preference for whether the App Bar shows or not. Setting to false has no effect on Windows.
| bShowAppBar | [IN]: kTrue to show App Bar, kFalse to hide. |
| pure virtual |
Set whether to show CCX Home workspace in no document state
| show | [IN], kTrue to show CCX Home workspace in no document state |
| pure virtual |
Set whether to show legacy New Document Dialog
| show | [IN], kTrue to show legacy New Document Dialog |
| pure virtual |
Set the current preference for showing the master page overlay for a Page Tool selection.
| show,kTrue | to show the master page overlay, kFalse to hide. |
| pure virtual |
Set whether to show "What's New" dialog on startup.
| showOnStartup | [IN], kTrue if "What's New" dialog should be shown on startup, kFalse otherwise. |
| pure virtual |
Set the tips preference
| newState | [IN]: whether or not and how tips are to be displayed |
| pure virtual |
Set the toolbox preference
| newOrientation | [IN]: toolbox orientation |
| pure virtual |
Set the current UI Panel auto show preference
| autoReveal | [IN]: true to make hidden panels auto reveal. |
| pure virtual |
Set the Preference for User Interface brightness
| 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. |
| 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.
| numOfOpenRecentFilesToDisplay | [IN]: number of Open Recent files to display. Must be from 1 to 30. |
| pure virtual |
Set the current UI Palette drawer persistence preference
| drawersStayOpen | [IN]: true to make palette drawers stay open. |
| 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.
| show,kTrue | to show the anchor adornment, kFalse to hide. |
| 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.
| show,kTrue | to show the content grabber adornment, kFalse to hide. |
| 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.
| show,kTrue | to show the live corners adornment, kFalse to hide. |
| pure virtual |
Set the current UI "Show Thumbnails Cursor" preference. Users may wish to turn this preference off if their computer is connected
| 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. |
| pure virtual |
Set the current preference for showing the ribbon.
| show,kTrue | to show the ribbon, kFalse to hide. |
| 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.
| show,kTrue | to show the stock purchase adornment, kFalse to hide. |
| pure virtual |
Set the current UI "Show Thumbnails Cursor" preference. Users may wish to turn this preference off if their computer is connected
| showThumbnails | [IN]: true to draw the Place cursor as a thumbnail of the imported file. |
| pure virtual |
Set the preference for whether the ApplicationContainer functions as an ApplicationFrame. Setting to false has no effect on Windows.
| iWantToLiveInABox | [IN]: true to make ApplicationContainer function as an ApplicationFrame. The horror... |
| pure virtual |
Set whether to use a custom monitor resolution (kTrue) or determine it from system settings (kFalse).
| bUseCustomResolution | [IN] kTrue to use the custom setting, kFalse to use system settings |
| pure virtual |
Get the preference for zooming all document windows when using the zoom tool.
| zoomAll | [IN]: true to enable zooming across document windows, false to disable. |