QuickApplyItemRecord Class Reference

#include <IQuickApplyService.h>

Public Attributes
PMString	fItemUIName
PMString	fPrefixKeyString
uint32	fItemID
bool16	fActive

Detailed Description

This class is used to return item type information. An implementation of IQuickApplyService is responsible for managing a certain class (type) of item in the quick apply dialog. For example, there is an IQuickApplyService provider implementation that handles character styles. When the method GetItemTypesHandled() is called it returns this record filled out that tells the quick apply dialog what it's character style items look like in the dialog display list so that the core dialog can know which service provider to ask to handle the apply action when the item is selected in the dialog later (and for other reasons). A service provider is allowed to handle more than one type of item so the routine GetItemTypesHandled() returns a list.

Author

Kevin Van Wiel

Member Data Documentation

bool16 QuickApplyItemRecord::fActive

Set to true if the type item referenced in this class should be shown in the quick apply dialog. When a service provider is called via GetItemTypesHandled() it should fill in the items default value for this.

uint32 QuickApplyItemRecord::fItemID

A unique id that can be used to identify this type item. Define via action id definitions see GetItemTypesHandled()

PMString QuickApplyItemRecord::fItemUIName

Tells the dialog what name to use for this type item in any quick apply dialog ui.

PMString QuickApplyItemRecord::fPrefixKeyString

Tells the dialog the prefix key the user can type to limit the list to only items of this type. Must be unique see GetItemTypesHandled() for how to determine uniqueness.