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

#include <ITriStateData.h>

Inheritance diagram for ITriStateData:
IPMUnknown

Public Types

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

Public Member Functions

virtual void Set (TriState newState)=0
 
virtual bool16 IsSelected ()=0
 
virtual bool16 IsDeselected ()=0
 
virtual bool16 IsUnknown ()=0
 
virtual TriState GetState ()=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

Data interface for storing a value that can be in one of three states. There is a similar interface used for widgets with

three possible states.

See Also
ITriStateControlData

Member Function Documentation

virtual TriState ITriStateData::GetState ()
pure virtual

Get the current state

virtual bool16 ITriStateData::IsDeselected ()
pure virtual

Check if the state is currently kUnselected

virtual bool16 ITriStateData::IsSelected ()
pure virtual

Check if the state is currently kSelected

virtual bool16 ITriStateData::IsUnknown ()
pure virtual

Check if the state is currently kUnknown

virtual void ITriStateData::Set (TriState newState)
pure virtual

Set the new state