Public Member Functions | Public Attributes

FPActionDef Class Reference

Search for all occurrences

Detailed Description

See also:
Class FPInterface, Class FPInterfaceDesc, Class FPActionDef, Class FPParamDef, Template Class Tab, Class MaxIcon, Function Publishing System, List of ControlType2 Choices, List of ParamType2 Choices.

Description:
This class is available in release 4.0 and later only.

FPActionDef, contains extra descriptor info for Action interface functions.
Data Members:
MSTR internal_cat;

The fixed, internal category name.

StringResID category;

The localizable category string resource ID.

FunctionID isEnabled_id;

The interface function IDs for the isEnabled predicate for this action.

FunctionID isChecked_id;

The interface function IDs for the isChecked predicate for this action.

FunctionID isVisible_id;

The interface function IDs for the isVisible predicate for this action.

ResID icon_resID;

The icon as resource ID.

MSTR icon_file;

The icon as UI .bmp filename, index pair, as per CUI icon specifications.

short icon_index;

The index of the icon associated with the action.

MaxIcon* icon;

The MaxIcon class data associated with this action.

StringResID button_text;

The button text string resource ID, defaults to function description.

StringResID tool_tip;

The tooltip string resource ID, defaults to function description.

StringResID menu_text;

The menu item text string resource ID, defaults to buttonText or function description.

ControlType2 ctrl_type;

The type of UI control, if f_ui specified.

ResID ctrl_pbID;

The control's host parammap pblock ID.

MapID ctrl_mapID;

The control's host parammap map ID within the block.

int ctrl_id;

The control dialog item ID.

COLORREF ctrl_hiCol;

The highlight color if check button.

ACCEL shortcut;

The default keyboard shortcut.

#include <ifnpub.h>

Inheritance diagram for FPActionDef:
Inheritance graph
[legend]

List of all members.

Public Member Functions

CoreExport  FPActionDef ()
CoreExport  ~FPActionDef ()

Public Attributes

DWORD  cbStruct
MSTR  internal_cat
StringResID  category
FunctionID  isEnabled_id
FunctionID  isChecked_id
FunctionID  isVisible_id
ResID  icon_resID
MSTR  icon_file
short  icon_index
MaxIcon icon
StringResID  button_text
StringResID  tool_tip
StringResID  menu_text
ControlType2  ctrl_type
ResID  ctrl_pbID
MapID  ctrl_mapID
int  ctrl_id
COLORREF  ctrl_hiCol
ACCEL  shortcut
FPMacroEmitter macro_emitter

Constructor & Destructor Documentation

CoreExport FPActionDef ( )
Remarks:
Constructor.

This will initialize the members to their empty default values.
CoreExport ~FPActionDef ( )
Remarks:
Destructor.

Member Data Documentation

DWORD cbStruct
StringResID category
FunctionID isEnabled_id
FunctionID isChecked_id
FunctionID isVisible_id
ResID icon_resID
short icon_index
StringResID button_text
StringResID tool_tip
StringResID menu_text
ControlType2 ctrl_type
ResID ctrl_pbID
MapID ctrl_mapID
int ctrl_id
COLORREF ctrl_hiCol
ACCEL shortcut

FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef
FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef FPActionDef