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)
	~UI_Value () override
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
void	handleEvent (UI_Event *event) override
void	deleteReferences (UI_Object *to_whom) override
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	getValuePrecise (UT_StringHolder &s) 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
SYS_FORCE_INLINE 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
const char *	className () const override
int	getNumInterested () const
UI_Object *	getInterest (int index) const
void	dumpInterests (std::ostream &os, const char *prefix=0) const
bool	isTraced () const
virtual void	setTraceLevel (TraceLevel tl)
TraceLevel	getTraceLevel () const
Public Member Functions inherited from UI_Object
	UI_Object ()
virtual	~UI_Object ()
	UI_Object (const UI_Object &)=delete
UI_Object &	operator= (const UI_Object &)=delete
virtual int	interestingEvent (UI_EventType t, UI_DeviceEvent *event) const
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)
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 *)

Protected Member Functions
void	clampValue (fpreal min_value, fpreal max_value)
void	showTrace ()
Protected Member Functions inherited from UI_Object
UI_ObjectList &	dependents ()
virtual void	preTerminateCallback ()

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

Additional Inherited Members
Static Public Member Functions inherited from UI_Object
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)

Detailed Description

Examples:

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

Definition at line 63 of file UI_Value.h.

Member Enumeration Documentation

enum UI_Value::TraceLevel

Enumerator
TL_NONE
TL_EVENT
TL_VALUE

Definition at line 228 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

UI_Value::~UI_Value ( )

override

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

Examples:

SOP/MSS_BrushHairLen.C, and ui/cmd_ui.C.

void UI_Value::clampValue ( fpreal  min_value, fpreal  max_value  )

inlineprotected

Definition at line 335 of file UI_Value.h.

const char* UI_Value::className ( ) const

inlineoverridevirtual

Reimplemented from UI_Object.

Definition at line 217 of file UI_Value.h.

void UI_Value::deleteReferences ( UI_Object *  to_whom )

overridevirtual

Reimplemented from UI_Object.

void UI_Value::dumpInterests	(	std::ostream &	os,
		const char *	prefix = 0
	)		const

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 139 of file UI_Value.h.

UI_Object * UI_Value::getInterest ( int  index ) const

inline

Definition at line 326 of file UI_Value.h.

int UI_Value::getNumInterested ( ) const

inline

Definition at line 320 of file UI_Value.h.

virtual void UI_Value::getRange ( fpreal *  min, fpreal *  max  ) const

virtual

const char* UI_Value::getString

(

)

const

TraceLevel UI_Value::getTraceLevel ( ) const

inline

Definition at line 238 of file UI_Value.h.

SYS_FORCE_INLINE UI_ValueType UI_Value::getType ( ) const

inline

Definition at line 167 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

void UI_Value::getValuePrecise

(

UT_StringHolder &

s

)

const

Same as getValue(UT_StringHolder &s) except it uses full precision for floating point to string conversions.

void UI_Value::handleEvent ( UI_Event *  event )

overridevirtual

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 236 of file UI_Value.h.

virtual int UI_Value::isVector ( ) const

inlinevirtual

Definition at line 168 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 197 of file UI_Value.h.

void UI_Value::operator= ( int64  i )

inline

Definition at line 198 of file UI_Value.h.

void UI_Value::operator= ( fpreal32  f )

inline

Definition at line 199 of file UI_Value.h.

void UI_Value::operator= ( fpreal64  f )

inline

Definition at line 200 of file UI_Value.h.

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

inline

Definition at line 201 of file UI_Value.h.

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

inline

Definition at line 202 of file UI_Value.h.

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

inline

Definition at line 203 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 138 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 237 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 258 of file UI_Value.h.

---

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

• UI/UI_Value.h