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

#include <IPanelDetailController.h>

Inheritance diagram for IPanelDetailController:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPANELDETAILCONTROLLER }
 

Public Member Functions

virtual void RotateDetailLevel ()=0
 
virtual void ShowDetailLevel (int16 nthLevel)=0
 
virtual int16 GetDetailLevel () const =0
 
virtual int16 GetNumDetailLevels () const =0
 
virtual int16 GetDefaultDetailLevel () const =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

Interface to allow varying level of detail exposed by a widget.

Member Function Documentation

virtual int16 IPanelDetailController::GetDefaultDetailLevel () const
pure virtual

Accessor default detail level.

Returns
the default detail level.
virtual int16 IPanelDetailController::GetDetailLevel () const
pure virtual

Accessor for current detail level, zero based. Previously, the GetCurrentDetailLevel method was 1 based, with 0 meaning minimized.

Returns
the current detail level.
virtual int16 IPanelDetailController::GetNumDetailLevels () const
pure virtual

Accessor for the number of detail levels. The minimum is always 1.

Returns
maximum detail level
virtual void IPanelDetailController::RotateDetailLevel ()
pure virtual

Switch the panel to show less detail, if at minimum detail level the show all detail. Return true if size of panel changed.

virtual void IPanelDetailController::ShowDetailLevel (int16 nthLevel)
pure virtual

Show nth detail level, zero based. Previously, the ShowNthDetailLevel method was 1 based, with 0 meaning minimized.

Parameters
nthLevelspecifies level of detail to show