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

#include <UI_Value.h>

+ Inheritance diagram for UI_Value:

Public Types

enum  TraceLevel { TL_NONE, TL_EVENT, TL_VALUE }
 

Public Member Functions

 UI_Value ()
 
 UI_Value (int32 i)
 
 UI_Value (int64 i)
 
 UI_Value (fpreal32 f)
 
 UI_Value (fpreal64 f)
 
 UI_Value (fpreal32 fp[], exint n)
 
 UI_Value (fpreal64 dp[], exint n)
 
 UI_Value (int32 ip[], exint n)
 
 UI_Value (int64 ip[], exint n)
 
 UI_Value (const UT_StringArray &ssp)
 
 UI_Value (const char *s)
 
 UI_Value (const UI_Value &v)
 
virtual ~UI_Value ()
 
virtual void setValue (int32 i)
 
virtual void setValue (int64 i)
 
virtual void setValue (fpreal64 f)
 
virtual void setValue (fpreal64 f, exint n)
 
virtual void setValue (int32 i, exint n)
 
virtual void setValue (int64 i, exint n)
 
virtual void setValue (const fpreal32 fp[], exint n)
 
virtual void setValue (const fpreal64 dp[], exint n)
 
virtual void setValue (const int32 ip[], exint n)
 
virtual void setValue (const int64 ip[], exint n)
 
virtual void setValue (const UT_StringArray &ssp)
 
virtual void setValue (const char *s)
 
virtual void setValue (const UI_Value &v)
 
void setValue (const UT_Color &c)
 
void setPointerValue (void *p)
 
void stringPrintf (const char *fmt,...)
 
virtual void changed (UI_Object *by, UI_Reason reason=UI_VALUE_CHANGED, UI_DeviceEvent *state=0)
 
void triggerImmediate (UI_Object *by, UI_Reason reason=UI_VALUE_CHANGED, UI_DeviceEvent *state=0)
 
void triggerDependents (UI_Object *by, UI_Reason reason=UI_VALUE_CHANGED, UI_DeviceEvent *state=0)
 
virtual void enable (bool state)
 
virtual void visible (bool state)
 
virtual void override (bool state, int)
 
virtual void open (bool state)
 
virtual void refresh ()
 
bool areAnyFeelClientsOpen () const
 
virtual void handleEvent (UI_Event *event)
 
virtual void deleteReferences (UI_Object *to_whom)
 
virtual void setSteps (fpreal mysmall, fpreal large)
 
virtual void setRange (fpreal min, fpreal max)
 
virtual void getRange (fpreal *min, fpreal *max) const
 
virtual void rangeCheck ()
 
virtual int step (UI_StepType how)
 
int save (std::ostream &os) const
 
bool load (UT_IStream &is)
 
void setFormat (const char *fmt)
 
const char * getFormat () const
 
void getValue (int32 *ip) const
 
void getValue (int64 *ip) const
 
void getValue (fpreal32 *fp) const
 
void getValue (fpreal64 *fp) const
 
void getValue (fpreal32 *fp, exint n) const
 
void getValue (fpreal64 *dp, exint n) const
 
void getValue (int32 *ip, exint n) const
 
void getValue (int64 *ip, exint n) const
 
void getValue (char *sp, exint bufsize) const
 
void getValue (char *sp, exint bufsize, const char *format) const
 
void getValue (UT_String &s) const
 
void getValue (UT_StringHolder &s) const
 
void getValue (UT_StringArray &ssp, exint n) const
 
void getValue (UI_Value &v) const
 
void getValue (UT_Color &color) const
 
void getValue (void **pp) const
 
void getArrayValue (fpreal *d, exint index) const
 
void getArrayValue (int32 *d, exint index) const
 
void getArrayValue (int64 *d, exint index) const
 
exint getArrayLength () const
 
UI_ValueType getType () const
 
virtual int isVector () const
 
void addInterest (UI_Object *client, UI_EventMethod method, bool check_dup=false)
 
void addPriorityInterest (UI_Object *client, UI_EventMethod method, bool check_dup=false)
 
bool hasInterest (UI_Object *in, UI_EventMethod method)
 
bool hasInterest (UI_Object *obj)
 
void removeInterest (UI_Object *in, UI_EventMethod method)
 
void removeInterest (UI_Object *client)
 
void removeAllInterests ()
 
const char * getString () const
 
void setString (char *sp)
 
char * stealString ()
 
void expandEnvironment ()
 
 operator const char * () const
 
 operator bool () const
 
 operator int32 () const
 
 operator int64 () const
 
 operator fpreal32 () const
 
 operator fpreal64 () const
 
 operator void * () const
 
void operator= (int32 i)
 
void operator= (int64 i)
 
void operator= (fpreal32 f)
 
void operator= (fpreal64 f)
 
void operator= (const char *s)
 
void operator= (const UI_Value &v)
 
void operator= (const UT_Color &c)
 
bool operator== (const UI_Value &v) const
 
bool operator== (const fpreal32 fp[]) const
 
bool operator== (const fpreal64 fp[]) const
 
bool operator== (const int32 ip[]) const
 
bool operator== (const int64 ip[]) const
 
bool operator== (const UT_StringArray &ssp) const
 
bool operator== (fpreal64 f) const
 
bool operator== (fpreal32 f) const
 
bool operator== (int32 i) const
 
bool operator== (int64 i) const
 
bool operator== (const char *s) const
 
virtual const char * className () const
 
unsigned int getNumInterested () const
 
UI_ObjectgetInterest (int index) const
 
bool isTraced () const
 
virtual void setTraceLevel (TraceLevel tl)
 
- Public Member Functions inherited from UI_Object
 UI_Object ()
 
virtual ~UI_Object ()
 
 UI_Object (const UI_Object &)=delete
 
UI_Objectoperator= (const UI_Object &)=delete
 
virtual int interestingEvent (UI_EventType t, UI_DeviceEvent *event) const
 
UI_ObjectgetParent () 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_ObjectListdependents () 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)
 
int getProxyId ()
 
void bumpQueueCount (int dir)
 
void setName (const char *symbolName)
 
const char * getName () const
 
void buildFullPath (UT_String &string) const
 
void debugQueueEventsFor (const UI_Value *value, const char *name, UI_EventType t=UI_EVENT_NO_EVENT) const
 
const UI_ValueListvalueInterests () const
 
void interestedInValue (UI_Value *)
 
void removeValueInterest (UI_Value *)
 

Protected Member Functions

void showTrace ()
 
- Protected Member Functions inherited from UI_Object
UI_ObjectListdependents ()
 
virtual void preTerminateCallback ()
 

Protected Attributes

union {
   exint   i
 
   fpreal   d
 
   fpreal *   a
 
   exint *   j
 
   char *   s
 
   char **   ss
 
   void *   p
 
value
 
const char * myFormat
 
UI_ValueType type:4
 
TraceLevel myTraceLevel:2
 

Friends

std::ostream & operator<< (std::ostream &os, const UI_Value &v)
 

Additional Inherited Members

- Static Public Member Functions inherited from UI_Object
static UI_ManagergetManager ()
 
static UI_Queue * getInputQueue ()
 
static int keycmp (const char *, int key)
 
static int keycmp (const char *, int key, const UI_HotkeyEcho &)
 

Detailed Description

Examples:
SOP/MSS_BrushHairLen.C, SOP/MSS_BrushHairLen.h, and ui/cmd_ui.C.

Definition at line 57 of file UI_Value.h.

Member Enumeration Documentation

Enumerator
TL_NONE 
TL_EVENT 
TL_VALUE 

Definition at line 214 of file UI_Value.h.

Constructor & Destructor Documentation

UI_Value::UI_Value ( )
UI_Value::UI_Value ( int32  i)
explicit
UI_Value::UI_Value ( int64  i)
explicit
UI_Value::UI_Value ( fpreal32  f)
explicit
UI_Value::UI_Value ( fpreal64  f)
explicit
UI_Value::UI_Value ( fpreal32  fp[],
exint  n 
)
explicit
UI_Value::UI_Value ( fpreal64  dp[],
exint  n 
)
explicit
UI_Value::UI_Value ( int32  ip[],
exint  n 
)
explicit
UI_Value::UI_Value ( int64  ip[],
exint  n 
)
explicit
UI_Value::UI_Value ( const UT_StringArray ssp)
explicit
UI_Value::UI_Value ( const char *  s)
explicit
UI_Value::UI_Value ( const UI_Value v)
explicit
virtual UI_Value::~UI_Value ( )
virtual

Member Function Documentation

void UI_Value::addInterest ( UI_Object client,
UI_EventMethod  method,
bool  check_dup = false 
)
Examples:
ui/cmd_ui.C.
void UI_Value::addPriorityInterest ( UI_Object client,
UI_EventMethod  method,
bool  check_dup = false 
)
bool UI_Value::areAnyFeelClientsOpen ( ) const
virtual void UI_Value::changed ( UI_Object by,
UI_Reason  reason = UI_VALUE_CHANGED,
UI_DeviceEvent state = 0 
)
virtual
virtual const char* UI_Value::className ( ) const
virtual

Reimplemented from UI_Object.

virtual void UI_Value::deleteReferences ( UI_Object to_whom)
virtual

Reimplemented from UI_Object.

virtual void UI_Value::enable ( bool  state)
virtual
void UI_Value::expandEnvironment ( )
exint UI_Value::getArrayLength ( ) const
void UI_Value::getArrayValue ( fpreal d,
exint  index 
) const
void UI_Value::getArrayValue ( int32 d,
exint  index 
) const
void UI_Value::getArrayValue ( int64 d,
exint  index 
) const
const char* UI_Value::getFormat ( ) const
inline

Definition at line 133 of file UI_Value.h.

UI_Object* UI_Value::getInterest ( int  index) const
unsigned int UI_Value::getNumInterested ( ) const
virtual void UI_Value::getRange ( fpreal min,
fpreal max 
) const
virtual
const char* UI_Value::getString ( ) const
UI_ValueType UI_Value::getType ( void  ) const
inline

Definition at line 157 of file UI_Value.h.

void UI_Value::getValue ( int32 ip) const
void UI_Value::getValue ( int64 ip) const
void UI_Value::getValue ( fpreal32 fp) const
void UI_Value::getValue ( fpreal64 fp) const
void UI_Value::getValue ( fpreal32 fp,
exint  n 
) const
void UI_Value::getValue ( fpreal64 dp,
exint  n 
) const
void UI_Value::getValue ( int32 ip,
exint  n 
) const
void UI_Value::getValue ( int64 ip,
exint  n 
) const
void UI_Value::getValue ( char *  sp,
exint  bufsize 
) const
void UI_Value::getValue ( char *  sp,
exint  bufsize,
const char *  format 
) const
void UI_Value::getValue ( UT_String s) const
void UI_Value::getValue ( UT_StringHolder s) const
void UI_Value::getValue ( UT_StringArray ssp,
exint  n 
) const
void UI_Value::getValue ( UI_Value v) const
void UI_Value::getValue ( UT_Color color) const
void UI_Value::getValue ( void **  pp) const
virtual void UI_Value::handleEvent ( UI_Event event)
virtual

Reimplemented from UI_Object.

bool UI_Value::hasInterest ( UI_Object in,
UI_EventMethod  method 
)
bool UI_Value::hasInterest ( UI_Object obj)
bool UI_Value::isTraced ( ) const
inline

Definition at line 221 of file UI_Value.h.

virtual int UI_Value::isVector ( ) const
inlinevirtual

Definition at line 158 of file UI_Value.h.

bool UI_Value::load ( UT_IStream is)
virtual void UI_Value::open ( bool  state)
virtual
UI_Value::operator bool ( ) const
UI_Value::operator const char * ( ) const
UI_Value::operator fpreal32 ( ) const
UI_Value::operator fpreal64 ( ) const
UI_Value::operator int32 ( ) const
UI_Value::operator int64 ( ) const
UI_Value::operator void * ( ) const
void UI_Value::operator= ( int32  i)
inline

Definition at line 187 of file UI_Value.h.

void UI_Value::operator= ( int64  i)
inline

Definition at line 188 of file UI_Value.h.

void UI_Value::operator= ( fpreal32  f)
inline

Definition at line 189 of file UI_Value.h.

void UI_Value::operator= ( fpreal64  f)
inline

Definition at line 190 of file UI_Value.h.

void UI_Value::operator= ( const char *  s)
inline

Definition at line 191 of file UI_Value.h.

void UI_Value::operator= ( const UI_Value v)
inline

Definition at line 192 of file UI_Value.h.

void UI_Value::operator= ( const UT_Color c)
inline

Definition at line 193 of file UI_Value.h.

bool UI_Value::operator== ( const UI_Value v) const
bool UI_Value::operator== ( const fpreal32  fp[]) const
bool UI_Value::operator== ( const fpreal64  fp[]) const
bool UI_Value::operator== ( const int32  ip[]) const
bool UI_Value::operator== ( const int64  ip[]) const
bool UI_Value::operator== ( const UT_StringArray ssp) const
bool UI_Value::operator== ( fpreal64  f) const
bool UI_Value::operator== ( fpreal32  f) const
bool UI_Value::operator== ( int32  i) const
bool UI_Value::operator== ( int64  i) const
bool UI_Value::operator== ( const char *  s) const
virtual void UI_Value::override ( bool  state,
int   
)
virtual
virtual void UI_Value::rangeCheck ( )
virtual
virtual void UI_Value::refresh ( )
virtual
void UI_Value::removeAllInterests ( )
void UI_Value::removeInterest ( UI_Object in,
UI_EventMethod  method 
)
void UI_Value::removeInterest ( UI_Object client)
int UI_Value::save ( std::ostream &  os) const
void UI_Value::setFormat ( const char *  fmt)
inline

Definition at line 132 of file UI_Value.h.

void UI_Value::setPointerValue ( void p)
virtual void UI_Value::setRange ( fpreal  min,
fpreal  max 
)
virtual
virtual void UI_Value::setSteps ( fpreal  mysmall,
fpreal  large 
)
virtual
void UI_Value::setString ( char *  sp)
virtual void UI_Value::setTraceLevel ( TraceLevel  tl)
inlinevirtual

Definition at line 222 of file UI_Value.h.

virtual void UI_Value::setValue ( int32  i)
virtual
virtual void UI_Value::setValue ( int64  i)
virtual
virtual void UI_Value::setValue ( fpreal64  f)
virtual
virtual void UI_Value::setValue ( fpreal64  f,
exint  n 
)
virtual
virtual void UI_Value::setValue ( int32  i,
exint  n 
)
virtual
virtual void UI_Value::setValue ( int64  i,
exint  n 
)
virtual
virtual void UI_Value::setValue ( const fpreal32  fp[],
exint  n 
)
virtual
virtual void UI_Value::setValue ( const fpreal64  dp[],
exint  n 
)
virtual
virtual void UI_Value::setValue ( const int32  ip[],
exint  n 
)
virtual
virtual void UI_Value::setValue ( const int64  ip[],
exint  n 
)
virtual
virtual void UI_Value::setValue ( const UT_StringArray ssp)
virtual
virtual void UI_Value::setValue ( const char *  s)
virtual
virtual void UI_Value::setValue ( const UI_Value v)
virtual
void UI_Value::setValue ( const UT_Color c)
void UI_Value::showTrace ( )
protected
char* UI_Value::stealString ( )
virtual int UI_Value::step ( UI_StepType  how)
virtual
void UI_Value::stringPrintf ( const char *  fmt,
  ... 
)
void UI_Value::triggerDependents ( UI_Object by,
UI_Reason  reason = UI_VALUE_CHANGED,
UI_DeviceEvent state = 0 
)
void UI_Value::triggerImmediate ( UI_Object by,
UI_Reason  reason = UI_VALUE_CHANGED,
UI_DeviceEvent state = 0 
)
virtual void UI_Value::visible ( bool  state)
virtual

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const UI_Value v 
)
friend

Definition at line 251 of file UI_Value.h.

Member Data Documentation

fpreal* UI_Value::a

Definition at line 228 of file UI_Value.h.

fpreal UI_Value::d

Definition at line 227 of file UI_Value.h.

exint UI_Value::i

Definition at line 226 of file UI_Value.h.

exint* UI_Value::j

Definition at line 229 of file UI_Value.h.

const char* UI_Value::myFormat
protected

Definition at line 234 of file UI_Value.h.

TraceLevel UI_Value::myTraceLevel
protected

Definition at line 236 of file UI_Value.h.

void* UI_Value::p

Definition at line 232 of file UI_Value.h.

char* UI_Value::s

Definition at line 230 of file UI_Value.h.

char** UI_Value::ss

Definition at line 231 of file UI_Value.h.

UI_ValueType UI_Value::type
protected

Definition at line 235 of file UI_Value.h.

union { ... } UI_Value::value

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