InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IBookUIUtils Class Referenceabstract

#include <IBookUIUtils.h>

Inheritance diagram for IBookUIUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IBOOKUIUTILS }
 

Public Member Functions

virtual int32 GetListItems (IPanelControlData *panelData)=0
 
virtual int32 GetSelectedBookContents (K2Vector< int32 > &selectedItems, UIDList *&selectedUIDList, IPanelControlData *panelData)=0
 
virtual void GetBookFileFromBookPanel (IDFile &bookFile, IPMUnknown *widget)=0
 
virtual IPanelControlData * QueryBookPanelData (IPMUnknown *widget)=0
 
virtual IPanelControlData * QueryActiveBookPanel (void)=0
 
virtual void SetBookPanelWidget (IPMUnknown *widget)=0
 
virtual IPMUnknown * GetBookPanelWidget (void)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface exposes some utility functions related to book UI.

See Also
kUtilsBoss

Member Enumeration Documentation

anonymous enum

kDefaultIID

Member Function Documentation

virtual void IBookUIUtils::GetBookFileFromBookPanel (IDFile & bookFile,
IPMUnknown * widget 
)
pure virtual

Get book file from book panel..

Parameters
bookFiledescribes the IDFile of the book. This is an out parameter.
widget,IPMUnknowninterface for widget in book panel. Typically comes from UpdateActionStates or DoAction from action manager.
Returns
void.
virtual IPMUnknown* IBookUIUtils::GetBookPanelWidget (void )
pure virtual

INTERNAL USE ONLY private function, DO NOT USE.

Parameters
void.
Returns
widget, IPMUnknown interface from UpdateActionStates or DoAction from action manager.
virtual int32 IBookUIUtils::GetListItems (IPanelControlData * panelData)
pure virtual

Get the total list items(documents) from the book panel.

Parameters
panelDatadescribes the book panel control data.
Returns
int32 indicating how many items(documents) in the book panel.
virtual int32 IBookUIUtils::GetSelectedBookContents (K2Vector< int32 > & selectedItems,
UIDList *& selectedUIDList,
IPanelControlData * panelData 
)
pure virtual

Helper function to return the indices of selected items in this list and their BookContent(Indd document) UIDs.

Parameters
selectedItemsdescribe the indices of the selected items. This is an out parameter.
selectedUIDListdescribe book content UIDs corresponding to the selected items. This is an out parameter.
panelDatadescribe the book panel control data and use widget parent interface of the panel to find the list box and then the selected items
Returns
int32 as the number of selected items.
virtual IPanelControlData* IBookUIUtils::QueryActiveBookPanel (void )
pure virtual

Query the book panel data for the active book (IBookManager::GetCurrentActiveBook)

Parameters
void.
Returns
panel control data of the book.
virtual IPanelControlData* IBookUIUtils::QueryBookPanelData (IPMUnknown * widget)
pure virtual

Query the book panel data from the current active UI such as panel's popup menu, panel's current selection, buttons on the panel etc.

Parameters
widget,IPMUnknowninterface for widget in book panel. Typically comes from UpdateActionStates or DoAction from action manager.
Returns
panel control data of the book.
virtual void IBookUIUtils::SetBookPanelWidget (IPMUnknown * widget)
pure virtual

INTERNAL USE ONLY private function, DO NOT USE.

Parameters
widget,IPMUnknowninterface for from UpdateActionStates or DoAction from action manager.
Returns
void.