HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
UI_Object Class Reference

#include <UI_Object.h>

+ Inheritance diagram for UI_Object:

Public Member Functions

 UI_Object ()
 
virtual ~UI_Object ()
 
 UI_Object (const UI_Object &)=delete
 
UI_Object & operator= (const UI_Object &)=delete
 
virtual void handleEvent (UI_Event *event)
 
virtual int interestingEvent (UI_EventType t, UI_DeviceEvent *event) const
 
virtual void deleteReferences (UI_Object *to_whom)
 
UI_Object * getParent () const
 
void setParent (UI_Object *p)
 
bool isAncestor (const UI_Object *who) const
 
void addDependent (UI_Object *who)
 
bool removeDependent (UI_Object *who)
 
bool replaceDependent (UI_Object *who, UI_Object *with)
 
bool isDependent (UI_Object *who) const
 
bool hasDependents () const
 
const UI_ObjectList & dependents () const
 
void sendEvent (const UI_Event &e) const
 
void distributeEvent (UI_Event *event, int upwards)
 
void relayEvent (UI_Event *event, UI_Object *target)
 
void generateEvent (UI_EventType t, UI_Object *target)
 
void purgeEvents (UI_EventType t, UI_Object *target, UI_EventMethod method=0)
 
void triggerImmediateEvent (UI_Event *event, int upwards)
 
virtual const char * className () const
 
int getProxyId ()
 
void bumpQueueCount (int dir)
 
void setName (const char *symbolName)
 
const char * getName () const
 
void buildFullPath (UT_WorkBuffer &string) const
 
void debugQueueEventsFor (const UI_Value *value, const char *name, UI_EventType t=UI_EVENT_NO_EVENT) const
 
const UI_ValueList & valueInterests () const
 
void interestedInValue (UI_Value *)
 
void removeValueInterest (UI_Value *)
 
void addKeyDelegateClientship (UI_KeyDelegate *)
 
void removeKeyDelegateClientship (UI_KeyDelegate *)
 

Static Public Member Functions

static UI_Manager * getManager ()
 
static UI_Queue * getInputQueue ()
 
static int keycmp (const char *, int key)
 
static int keycmp (const char *, int key, const UI_HotkeyEcho &)
 
static void keyEcho (const char *, const UI_HotkeyEcho &)
 
static void actionKeyEcho (const char *, const char *custom_suffix=0)
 
static void toggleKeyEcho (const char *, bool new_value)
 

Protected Member Functions

UI_ObjectList & dependents ()
 
virtual void preTerminateCallback ()
 

Friends

class UI_Manager
 

Detailed Description

Definition at line 45 of file UI_Object.h.

Constructor & Destructor Documentation

UI_Object::UI_Object ( )
virtual UI_Object::~UI_Object ( )
virtual
UI_Object::UI_Object ( const UI_Object &  )
delete

Member Function Documentation

static void UI_Object::actionKeyEcho ( const char *  ,
const char *  custom_suffix = 0 
)
static
void UI_Object::addDependent ( UI_Object *  who)
void UI_Object::addKeyDelegateClientship ( UI_KeyDelegate *  )
void UI_Object::buildFullPath ( UT_WorkBuffer &  string) const
void UI_Object::bumpQueueCount ( int  dir)
inline

Definition at line 91 of file UI_Object.h.

virtual const char* UI_Object::className ( ) const
inlinevirtual

Reimplemented in BM_State, UI_Value, BM_SimpleState, OP3D_InputSelector, HDK_Sample::MyDialog, BM_SingleOpState, AP_Interface, MSS_SingleOpState, HDK_Sample::MSS_CustomBrushState, BM_OpState, BM_ParmState, MSS_BrushBaseState, HDK_Sample::MSS_BrushHairLen, HDK_Sample::MSS_BrushHairLenSelector, OP3D_GenericSelector, DM_InputSelector, MSS_SingleOpBaseState, UI_OHTriggerObject, MSS_ReusableSelector, and BM_InputSelector.

Definition at line 87 of file UI_Object.h.

void UI_Object::debugQueueEventsFor ( const UI_Value *  value,
const char *  name,
UI_EventType  t = UI_EVENT_NO_EVENT 
) const
virtual void UI_Object::deleteReferences ( UI_Object *  to_whom)
virtual

Reimplemented in UI_Value.

const UI_ObjectList& UI_Object::dependents ( ) const
inline

Definition at line 73 of file UI_Object.h.

UI_ObjectList& UI_Object::dependents ( )
inlineprotected

Definition at line 136 of file UI_Object.h.

void UI_Object::distributeEvent ( UI_Event *  event,
int  upwards 
)
void UI_Object::generateEvent ( UI_EventType  t,
UI_Object *  target 
)
static UI_Queue* UI_Object::getInputQueue ( )
inlinestatic

Definition at line 111 of file UI_Object.h.

static UI_Manager* UI_Object::getManager ( )
inlinestatic

Definition at line 110 of file UI_Object.h.

const char* UI_Object::getName ( ) const
UI_Object* UI_Object::getParent ( ) const
inline

Definition at line 64 of file UI_Object.h.

int UI_Object::getProxyId ( )
virtual void UI_Object::handleEvent ( UI_Event *  event)
virtual

Reimplemented in AP_Interface, and UI_Value.

bool UI_Object::hasDependents ( ) const
inline

Definition at line 72 of file UI_Object.h.

void UI_Object::interestedInValue ( UI_Value *  )
virtual int UI_Object::interestingEvent ( UI_EventType  t,
UI_DeviceEvent *  event 
) const
virtual
bool UI_Object::isAncestor ( const UI_Object *  who) const
bool UI_Object::isDependent ( UI_Object *  who) const
static int UI_Object::keycmp ( const char *  ,
int  key 
)
static
static int UI_Object::keycmp ( const char *  ,
int  key,
const UI_HotkeyEcho &   
)
static
static void UI_Object::keyEcho ( const char *  ,
const UI_HotkeyEcho &   
)
static
UI_Object& UI_Object::operator= ( const UI_Object &  )
delete
virtual void UI_Object::preTerminateCallback ( )
inlineprotectedvirtual

Definition at line 141 of file UI_Object.h.

void UI_Object::purgeEvents ( UI_EventType  t,
UI_Object *  target,
UI_EventMethod  method = 0 
)
void UI_Object::relayEvent ( UI_Event *  event,
UI_Object *  target 
)
bool UI_Object::removeDependent ( UI_Object *  who)
void UI_Object::removeKeyDelegateClientship ( UI_KeyDelegate *  )
void UI_Object::removeValueInterest ( UI_Value *  )
bool UI_Object::replaceDependent ( UI_Object *  who,
UI_Object *  with 
)
void UI_Object::sendEvent ( const UI_Event &  e) const
void UI_Object::setName ( const char *  symbolName)
void UI_Object::setParent ( UI_Object *  p)
inline

Definition at line 65 of file UI_Object.h.

static void UI_Object::toggleKeyEcho ( const char *  ,
bool  new_value 
)
static
void UI_Object::triggerImmediateEvent ( UI_Event *  event,
int  upwards 
)
const UI_ValueList& UI_Object::valueInterests ( ) const
inline

Definition at line 122 of file UI_Object.h.

Friends And Related Function Documentation

friend class UI_Manager
friend

Definition at line 154 of file UI_Object.h.

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