InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IUIScalingPrefs Class Referenceabstract
Inheritance diagram for IUIScalingPrefs:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IUISCALINGPREFS }
 
enum  ScalingFactorPref { kLower = 0, kHigher }
 
enum  ScalingRange { kMinScaling = 1, kMaxScaling = 3 }
 

Public Member Functions

virtual PMReal GetScaleFactorValue ()=0
 
virtual bool16 GetScaleCursor ()=0
 
virtual PMReal GetBoundingBoxValue ()=0
 
virtual int32 GetNumStops ()=0
 
virtual bool16 GetHasUserUpdatedPrefs ()=0
 
virtual void SetScaleFactorValue (PMReal &scaleFactor)=0
 
virtual void SetScaleCursor (bool16 &scaleCursor)=0
 
virtual void SetBoundingBoxValue (PMReal &boundingBox)=0
 
virtual void SetNumSliderStops (int32 &numStops)=0
 
virtual void SetHasUserUpdatedPrefs (bool16 &hasUpdatedPrefs)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual PMReal IUIScalingPrefs::GetBoundingBoxValue ()
pure virtual

Returns the bounding box, handles and adornment scale factor stored in preferences.

virtual bool16 IUIScalingPrefs::GetHasUserUpdatedPrefs ()
pure virtual

Returns a boolean value indicating that user has updated UI Scaling preferences

virtual int32 IUIScalingPrefs::GetNumStops ()
pure virtual

Returns the number of stops in the UI scaling slider to be shown to the user based on the screen resolution and OS scale factor.

virtual bool16 IUIScalingPrefs::GetScaleCursor ()
pure virtual

Returns the boolean value stored in preferences for whether the cursor should be scaled or not.

virtual PMReal IUIScalingPrefs::GetScaleFactorValue ()
pure virtual

Returns the current value of UI Scaling scalefactor stored in preferences.

virtual void IUIScalingPrefs::SetBoundingBoxValue (PMRealboundingBox)
pure virtual

Sets the bounding box scale factor.

Parameters
boundingBoxthe scale factor for the scaling of adornments, bounding boxes and handles.
virtual void IUIScalingPrefs::SetHasUserUpdatedPrefs (bool16 & hasUpdatedPrefs)
pure virtual

INTERNAL USE ONLY. Sets a boolean value indicating that user has updated UI Scaling preferences

Parameters
hasUpdatedPrefsSets a boolean value indicating that user has updated UI Scaling preferences
virtual void IUIScalingPrefs::SetNumSliderStops (int32 & numStops)
pure virtual

Sets the number of slider stops in the UI scaling slider.

Parameters
numStopsthe number of stops that should be there in the UI scaling slider.
virtual void IUIScalingPrefs::SetScaleCursor (bool16 & scaleCursor)
pure virtual

Sets the boolean value whether the cursors should scale or not.

Parameters
scaleCursorif True the cursors would be scaled to effective scale factor, otherwise to OS scale factor.
virtual void IUIScalingPrefs::SetScaleFactorValue (PMRealscaleFactor)
pure virtual

Sets the UI scaling scale factor preference.

Parameters
scaleFactorthe application scale factor.s