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

Public Types

enum  { kDefaultIID = IID_IMONITORINFO }
 

Public Member Functions

virtual GSysRect GetMainScreenRect () const =0
 
virtual GSysRect GetScreenRect (const SysPoint &refPoint) const =0
 
virtual GSysRect GetPaletteAreaRect () const =0
 
virtual GSysRect GetPaletteAreaRect (const SysPoint &refPoint) const =0
 
virtual GSysRect GetClientAreaRect () const =0
 
virtual GSysRect GetGlobalDocWindowAreaRect () const =0
 
virtual SysRect GetLocalDocWindowAreaRect () const =0
 
virtual void SetDocWindowAreaRect (const GSysRect &newDocWindowRect)=0
 
virtual GSysRect GetBestScreenRect (const SysRect &refRect) const =0
 
virtual int32 GetNumberOfMonitors () const =0
 
virtual PMReal GetMainScreenPixelsPerInch (bool32 honorUserInterfacePrefs=kTrue) const =0
 
virtual PMReal GetScreenPixelsPerInch (const SysPoint &refPoint, bool32 honorUserInterfacePrefs=kTrue) const =0
 
virtual PMReal GetScreenPixelsPerInch (const IControlView *view, bool32 honorUserInterfacePrefs=kTrue) const =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 GSysRect IMonitorInfo::GetBestScreenRect (const SysRectrefRect) const
pure virtual

Returns the bounds of the screen that best encloses the passed-in rectangle

Parameters
refRectIN the rectangle to test
Returns
GSysRect OUT best screen bounds
virtual GSysRect IMonitorInfo::GetClientAreaRect () const
pure virtual

Returns the area of the screen inside the app window and all docked palettes(toolbars, TabStation, etc.)

Returns
GSysRect OUT client area bounds
virtual GSysRect IMonitorInfo::GetGlobalDocWindowAreaRect () const
pure virtual

Calculate the effective area of the screen in which to position the document windows. This takes into account Toolbars docked to the app frame NOTE: This area encompasses the entire main monitor minus: Top: the Menubar height (Macintosh) Bottom: a small constant Right: a small constant Additional space for the Dock (Macintosh)

Returns
GSysRect OUT doc window area bounds
virtual SysRect IMonitorInfo::GetLocalDocWindowAreaRect () const
pure virtual

Calculate the effective area of the app frame window in which to position the document windows. This is the area within the app window and all docked palettes(toolbars, TabStation) NOTE: This area encompasses the entire client area of the frame window. Macintosh - Main screen minus the menubar and dock (Same as GetPaletteAreaRect()) Windows - The MDI client area of the application.

Returns
SysRect OUT local doc window area bounds. NOTE: Rect is returned in Local Coordinates of the MDI client window(i.e. TopLeft will always be at 0,0)
virtual PMReal IMonitorInfo::GetMainScreenPixelsPerInch (bool32 honorUserInterfacePrefs = kTrue) const
pure virtual

Returns the number of pixels per inch of the main monitor

Parameters
honorUserInterfacePrefs[IN] If true, then look at the IUserInterfacePreferences::GetUseCustomMonitorResolution() function. If it returns true, then return IUserInterfacePreferences::GetCustomMonitorResolution(). Otherwise, use system API calls to determine the resolution.
virtual GSysRect IMonitorInfo::GetMainScreenRect () const
pure virtual

Get rect for the main screen bounds

Returns
GSysRect OUT screen bounds
virtual int32 IMonitorInfo::GetNumberOfMonitors () const
pure virtual

Returns the number of connected and active monitors

Returns
int32 OUT number of monitors
virtual GSysRect IMonitorInfo::GetPaletteAreaRect () const
pure virtual

Calculate the effective area of the screen in which to position the docking palettes. On the mac, this is the main screen minus the menubar To find the area within the docking palettes, call GetGlobalDocWindowAreaRect()

Returns
GSysRect OUT palette area bounds
virtual GSysRect IMonitorInfo::GetPaletteAreaRect (const SysPointrefPoint) const
pure virtual

Calculate the effective area of the screen which contains the passed in point in which to position the docking palettes. On the mac, this is the removes the menubar and dockbar if present

Parameters
refPointIN The point in question
Returns
GSysRect OUT palette area bounds
virtual PMReal IMonitorInfo::GetScreenPixelsPerInch (const SysPointrefPoint,
bool32 honorUserInterfacePrefs = kTrue 
) const
pure virtual

Returns the number of pixels per inch for the screen which contains the passed in point.

Parameters
refPointIN The point in question
honorUserInterfacePrefs[IN] If true, then look at the IUserInterfacePreferences::GetUseCustomMonitorResolution() function. If it returns true, then return IUserInterfacePreferences::GetCustomMonitorResolution(). Otherwise, use system API calls to determine the resolution.
Returns
The number of pixels per inch
virtual PMReal IMonitorInfo::GetScreenPixelsPerInch (const IControlViewview,
bool32 honorUserInterfacePrefs = kTrue 
) const
pure virtual

Returns the number of pixels per inch for the screen which contains the center point of the passed in view.

Parameters
viewIN The view in question
honorUserInterfacePrefs[IN] If true, then look at the IUserInterfacePreferences::GetUseCustomMonitorResolution() function. If it returns true, then return IUserInterfacePreferences::GetCustomMonitorResolution(). Otherwise, use system API calls to determine the resolution.
Returns
The number of pixels per inch
virtual GSysRect IMonitorInfo::GetScreenRect (const SysPointrefPoint) const
pure virtual

Get rect for the screen which contains the passed in point.

Parameters
refPointIN The point in question
Returns
GSysRect OUT screen bounds
virtual void IMonitorInfo::SetDocWindowAreaRect (const GSysRectnewDocWindowRect)
pure virtual

INTERNAL USE ONLY. Set the size of the doc window area. This should only be called by the PaletteMgr after sizing palettes.

Parameters
newDocWindowRectIN new document area bounds