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

#include <IBooleanControlData.h>

Inheritance diagram for IBooleanControlData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IBOOLEANCONTROLDATA }
 

Public Member Functions

virtual void Select (bool16 updateView=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual void Deselect (bool16 updateView=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual void Toggle (bool16 updateView=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual bool16 IsSelected () 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 on bi-state controls that can be in two states; selected or deselected.

Member Function Documentation

virtual void IBooleanControlData::Deselect (bool16 updateView = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Method to set the state to deselected.

Parameters
updateViewspecifies whether the control should be redrawn
notifyOfChangespecifies whether observers on the control data should be notified of the change.
virtual bool16 IBooleanControlData::IsSelected () const
pure virtual

Accessor to determine whether the control is in selected state

Returns
kTrue if the control is in the selected state, kFalse if deselected
virtual void IBooleanControlData::Select (bool16 updateView = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Method to set the control state to be selected.

Parameters
updateViewspecifies whether the control should be redrawn
notifyOfChangespecifies whether observers on the control data should be notified of the change.
virtual void IBooleanControlData::Toggle (bool16 updateView = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Method to change the state to the logical opposite.

Parameters
updateViewspecifies whether the control should be redrawn
notifyOfChangespecifies whether observers on the control data should be notified of the change