InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SelectionToolInfo Class Reference

#include <ToolInfo.h>

Public Types

typedef object_type data_type
 

Public Member Functions

 SelectionToolInfo ()
 
 SelectionToolInfo (const ClassID &toolType, const PMIID &selectionProtocol, const PMIID &nonSelectionProtocol, const WidgetID &selectionWidgetID, const WidgetID &nonSelectionWidgetID, const ToolInfoPriority selectionPriority, const ToolInfoPriority nonSelectionPriority)
 
bool16 operator== (const SelectionToolInfo &other) const
 

Public Attributes

ClassID fToolType
 
PMIID fSelectionProtocol
 
PMIID fNonSelectionProtocol
 
WidgetID fSelectionWidgetID
 
WidgetID fNonSelectionWidgetID
 
ToolInfoPriority fSelectionPriority
 
ToolInfoPriority fNonSelectionPriority
 

Detailed Description

Helper class for cache selection tool information. This is primary used for InfoPalette.

Constructor & Destructor Documentation

SelectionToolInfo::SelectionToolInfo ()
inline

Default constructor.

SelectionToolInfo::SelectionToolInfo (const ClassIDtoolType,
const PMIIDselectionProtocol,
const PMIIDnonSelectionProtocol,
const WidgetIDselectionWidgetID,
const WidgetIDnonSelectionWidgetID,
const ToolInfoPriority selectionPriority,
const ToolInfoPriority nonSelectionPriority 
)
inline

Construct object with given values.

Parameters
toolTypeIN ClassID for tool.
protocolIN protocol when there is selection.
widgetIDIN widgetID for the panel when there is selection.
priorityIN determine which panel should be loaded if one tool has multiple panels associated with.

Member Function Documentation

bool16 SelectionToolInfo::operator== (const SelectionToolInfoother) const
inline

Equal operator to compare objects.

Parameters
otherIN the object to be compared with.
Returns
bool16 kTrue means equal, otherwise kFalse.