HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PI_StateTemplate Class Reference

#include <PI_ResourceTemplate.h>

+ Inheritance diagram for PI_StateTemplate:

Public Member Functions

 PI_StateTemplate (const char *name, const char *english, const char *icon_name, void *constructor, PRM_Template *templates, PI_ViewerType viewer_type, unsigned network_types, int op_independent=1, const char *volatile_hotkey=0, OP_Operator *op=0)
 
virtual ~PI_StateTemplate ()
 
void initialize (const char *name, const char *english, const char *icon_name, void *constructor, PRM_Template *templates, PI_ViewerType viewer_type, unsigned network_types, int op_independent=1, const char *volatile_hotkey=0, bool hidden=false)
 
void rebuildVolatileKeys (UT_Array< int > *injectionKeys=0, UT_Array< int > *injectionKeysModifiers=0)
 
PRM_Templatetemplates ()
 
const PRM_Templatetemplates () const
 
PI_ViewerType viewerType () const
 
unsigned networkTypes () const
 
const char * getIconName () const
 
int opIndependent () const
 
const UT_Array< int > & volatileKeys ()
 
const UT_Array< int > & volatileKeysModifiers ()
 
const char * getHotkeyString () const
 
OP_OperatorgetOperator () const
 
void setHidden (bool hide)
 
bool getHidden () const
 
- Public Member Functions inherited from PI_ResourceTemplate
 PI_ResourceTemplate (const char *name, const char *english, void *constructor)
 
virtual ~PI_ResourceTemplate ()
 
void initialize (const char *name, const char *english, void *constructor)
 
const UT_Stringname () const
 
const UT_StringenglishName () const
 
voidconstructor () const
 
void constructor (void *c)
 

Protected Member Functions

void setVolatileKeys (const UT_Array< int > &keys, const UT_Array< int > &modifiers)
 

Detailed Description

Constructor & Destructor Documentation

PI_StateTemplate::PI_StateTemplate ( const char *  name,
const char *  english,
const char *  icon_name,
void constructor,
PRM_Template templates,
PI_ViewerType  viewer_type,
unsigned  network_types,
int  op_independent = 1,
const char *  volatile_hotkey = 0,
OP_Operator op = 0 
)
virtual PI_StateTemplate::~PI_StateTemplate ( )
virtual

Member Function Documentation

bool PI_StateTemplate::getHidden ( ) const
inline

Definition at line 145 of file PI_ResourceTemplate.h.

const char* PI_StateTemplate::getHotkeyString ( ) const
inline

Definition at line 138 of file PI_ResourceTemplate.h.

const char* PI_StateTemplate::getIconName ( ) const
inline

Definition at line 130 of file PI_ResourceTemplate.h.

OP_Operator* PI_StateTemplate::getOperator ( ) const
inline

Definition at line 140 of file PI_ResourceTemplate.h.

void PI_StateTemplate::initialize ( const char *  name,
const char *  english,
const char *  icon_name,
void constructor,
PRM_Template templates,
PI_ViewerType  viewer_type,
unsigned  network_types,
int  op_independent = 1,
const char *  volatile_hotkey = 0,
bool  hidden = false 
)
unsigned PI_StateTemplate::networkTypes ( ) const
inline

Definition at line 128 of file PI_ResourceTemplate.h.

int PI_StateTemplate::opIndependent ( ) const
inline

Definition at line 132 of file PI_ResourceTemplate.h.

void PI_StateTemplate::rebuildVolatileKeys ( UT_Array< int > *  injectionKeys = 0,
UT_Array< int > *  injectionKeysModifiers = 0 
)
void PI_StateTemplate::setHidden ( bool  hide)
inline

Definition at line 143 of file PI_ResourceTemplate.h.

void PI_StateTemplate::setVolatileKeys ( const UT_Array< int > &  keys,
const UT_Array< int > &  modifiers 
)
inlineprotected

Definition at line 149 of file PI_ResourceTemplate.h.

PRM_Template* PI_StateTemplate::templates ( )
inline

Definition at line 123 of file PI_ResourceTemplate.h.

const PRM_Template* PI_StateTemplate::templates ( ) const
inline

Definition at line 124 of file PI_ResourceTemplate.h.

PI_ViewerType PI_StateTemplate::viewerType ( ) const
inline

Definition at line 126 of file PI_ResourceTemplate.h.

const UT_Array<int>& PI_StateTemplate::volatileKeys ( )
inline

Definition at line 134 of file PI_ResourceTemplate.h.

const UT_Array<int>& PI_StateTemplate::volatileKeysModifiers ( )
inline

Definition at line 136 of file PI_ResourceTemplate.h.


The documentation for this class was generated from the following file: