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

Public Types

enum  { kDefaultIID = IID_IDROPDOWNLISTCONTROLLER }
 
enum  { kBeginning = 0, kNoSelection = -1, kEnd = -2, kDefaultSelection = -3 }
 

Public Member Functions

virtual void Select (int32 index, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual void Deselect (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual bool16 IsSelected (int32 index) const =0
 
virtual int32 GetSelected () const =0
 
virtual void SetDefaultSelection (int32 index)=0
 
virtual void Enable (int32 index, bool16 doEnable=kTrue, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual void Disable (int32 index, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual bool16 IsEnabled (int32 index) const =0
 
virtual bool16 IsDropDownOpen () 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 void IDropDownListController::Deselect (bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Deselect the element selected. No selection.

Returns
none
virtual void IDropDownListController::Disable (int32 index,
bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Disable the element at the given position in the list.

Returns
none
virtual void IDropDownListController::Enable (int32 index,
bool16 doEnable = kTrue,
bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Enable the element at the given position in the list.

Returns
none
virtual int32 IDropDownListController::GetSelected () const
pure virtual

Get index of the currently selected element.

Returns
the index of selected item, kNoSelection if no item selected
virtual bool16 IDropDownListController::IsDropDownOpen () const
pure virtual

Try to determine if dropdowm menu is open.

Returns
kTrue if dropdown menu is currently open, kFalse otherwise
virtual bool16 IDropDownListController::IsEnabled (int32 index) const
pure virtual

Is the given element enabled?

Returns
kTrue if enabled, kFalse otherwise
virtual bool16 IDropDownListController::IsSelected (int32 index) const
pure virtual

Is the given element selected?

Returns
kTrue if selected, kFalse otherwise
virtual void IDropDownListController::Select (int32 index,
bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Select the element at the given position in the list.

Returns
none
virtual void IDropDownListController::SetDefaultSelection (int32 index)
pure virtual

Set index of the element that should be selected when kDefaultSelection is passed into Select.

Returns
none