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

#include <ITriStateControlData.h>

Inheritance diagram for ITriStateControlData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITRISTATECONTROLDATA }
 
enum  TriState { kUnselected, kUnknown, kSelected }
 

Public Member Functions

virtual void Select (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual void Deselect (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual void SetUnknown (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual void SetState (TriState newState, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual bool16 IsSelected () const =0
 
virtual bool16 IsDeselected () const =0
 
virtual bool16 IsUnknown () const =0
 
virtual TriState GetState () 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

This interface handles the data for widgets with 3 possible states. The most common widgets that use this data interface are

Radio buttons and Checkboxes.

See Also
ITriStateData

Member Enumeration Documentation

anonymous enum

enum for DefaultIID to make UseDefaultIID() work for this interface

3 possible states for the widget

Member Function Documentation

virtual void ITriStateControlData::Deselect (bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Set the state of the widget to be kUnselected. Optionally invalidate and notify observers

virtual TriState ITriStateControlData::GetState () const
pure virtual

Get the current state of the widget

virtual bool16 ITriStateControlData::IsDeselected () const
pure virtual

Check if the state of the widget is currently kUnselected

virtual bool16 ITriStateControlData::IsSelected () const
pure virtual

Check if the state of the widget is currently kSelected

virtual bool16 ITriStateControlData::IsUnknown () const
pure virtual

Check if the state of the widget is currently kUnknown

virtual void ITriStateControlData::Select (bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Set the state of the widget to be kSelected. Optionally invalidate and notify observers

virtual void ITriStateControlData::SetState (TriState newState,
bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Set the state of the widget to a new state. Optionally invalidate and notify observers

virtual void ITriStateControlData::SetUnknown (bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Set the state of the widget to be kUnknown. Optionally invalidate and notify observers