InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IControlStripPrefs Class Referenceabstract

#include <IControlStripPrefs.h>

Inheritance diagram for IControlStripPrefs:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICONTROLSTRIPPREFS }
 
enum  { kCharacterMode = 0x00000001, kParagraphMode = 0x00000002 }
 

Public Member Functions

virtual int32 GetDisplayMode () const =0
 
virtual void SetDisplayMode (int32 displayMode)=0
 
virtual PMPoint GetFloatingDimensions () const =0
 
virtual void SetFloatingDimensions (const PMPoint &dimensions)=0
 
virtual void GetControlStripSetsVisibility (K2Vector< KeyValuePair< PMString, bool16 > > &controlSetsVisibility)=0
 
virtual void SetControlStripSetsVisibility (K2Vector< KeyValuePair< PMString, bool16 > > &controlSetsVisibility)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Preferences for control strip display preferences, persisted on session workspace.

Member Function Documentation

virtual void IControlStripPrefs::GetControlStripSetsVisibility (K2Vector< KeyValuePair< PMString, bool16 > > & controlSetsVisibility)
pure virtual

Return a list of the names of all the control sets (PMString) and corresponding visibility (bool16)

Parameters
K2Pair<PMString,bool16>&IN/OUT list parameter that will be filled out.
virtual int32 IControlStripPrefs::GetDisplayMode () const
pure virtual

How a control strip widget suite should display it's info. Used in calls to IControlStripWidgetSuite::GetEnabledWidgets

Returns
the display mode of the control strip
virtual PMPoint IControlStripPrefs::GetFloatingDimensions () const
pure virtual

Return the size of the control strip. Used for floating mode when coming out the dock and by the detail controller on this panel.

Returns
the dimeions of control strip when in floating mode
virtual void IControlStripPrefs::SetControlStripSetsVisibility (K2Vector< KeyValuePair< PMString, bool16 > > & controlSetsVisibility)
pure virtual

Set the visibility of one or more control sets. kTrue for visible, kFalse for hidden.

Parameters
K2Pair<PMString,bool16>&IN list parameter containing the name/visibility key value pair for those control sets to set their visibility.
virtual void IControlStripPrefs::SetDisplayMode (int32 displayMode)
pure virtual

Specify the display mode for the control strip

Parameters
displayModespecifies how the control strip should display its widgets
virtual void IControlStripPrefs::SetFloatingDimensions (const PMPointdimensions)
pure virtual

Set the dimensions of the control strip when in floating mode. Used internally by palette resizing code and detail controller code.

Parameters
dimesionsspecifies the default size of the control strip when going into floating mode.