IlvListLabel Class Reference

Graphic class. More...

#include <ilviews/graphics/lablist.h>

Inheritance diagram for IlvListLabel:

Public Member Functions
	IlvListLabel (IlvDisplay *display, const IlvPoint &position, IlUInt count, const char *const *labels, IlvPalette *palette=0)
	Initializes a new IlvListLabel from an array of strings. More...
	IlvListLabel (IlvDisplay *display, IlUInt count, const IlvPoint &position,...)
	Creates an IlvListLabel graphic object from a series of strings. More...
void	addLabel (const char *label)
	Adds a string. More...
IlvPosition	align () const
	Returns the alignment of the strings. More...
IlvPosition	align (IlvPosition align)
	Sets the alignment of the strings. More...
virtual void	applyTransform (const IlvTransformer *)
	Applies a transformation function to the graphic object. More...
virtual void	boundingBox (IlvRect &, const IlvTransformer *=0) const
	Retrieves the bounding box of the graphic object. More...
IlBoolean	contains (const IlvPoint &, const IlvPoint &, const IlvTransformer *=0) const
	Checks whether a point is in the object. More...
virtual void	draw (IlvPort *, const IlvTransformer *=0, const IlvRegion *=0) const
	Draws the graphic object. More...
IlUInt	getCardinal () const
	Returns the number of label strings. More...
const char *	getLabel (IlUInt index) const
	Returns the string at a given index. More...
const char *const *	getLabels (IlUInt &count) const
	Returns the array of strings. More...
IlvDeltaPos	getSpacing () const
	Returns the vertical spacing between lines. More...
const char *	getText () const
	Returns the contents of an array of strings. More...
IlBoolean	inside (const IlvRegion &, const IlvTransformer *=0) const
	Determines whether an object with transformation applied is inside the bounding box. More...
IlBoolean	intersects (const IlvRegion &, const IlvTransformer *=0) const
	Checks whether a region intersects the bounding box with transformation applied. More...
void	removeLabel (IlUInt index)
	Removes the string at a given index. More...
virtual void	setFont (IlvFont *)
	Sets the font of the object. More...
void	setLabel (const char *label, IlUInt index)
	Sets a label string at a given index. More...
void	setLabels (const char *const *labels, IlUInt count, IlBoolean copy=IlTrue)
	Sets the array of strings. More...
void	setSpacing (IlvDeltaPos spacing)
	Sets the vertical spacing between lines. More...
void	setText (const char *text)
	Resets the graphic object with a multiline string. More...
IlInt	whichContains (const IlvPoint &p, const IlvTransformer *t=0) const
	Returns the index of the string containing a given point. More...
virtual IlBoolean	zoomable () const
	Indicates whether the graphic object is zoomable. More...
Public Member Functions inherited from IlvSimpleGraphic
	IlvSimpleGraphic (IlvDisplay *display, IlvPalette *palette=0)
	Initializes a new IlvSimpleGraphic. More...
virtual	~IlvSimpleGraphic ()
	Destructor. More...
virtual void	applyResources (const char *, const char *, const char *, const char *, IlvDisplay *=0)
	Applies resources on a graphic object. More...
IlvIntensity	getAlpha () const
	Retrieves the alpha value. More...
IlvAntialiasingMode	getAntialiasingMode () const
	Retrieves the anti-aliasing mode. More...
IlvArcMode	getArcMode () const
	Retrieves the arc mode. More...
IlvColor *	getBackground () const
	Retrieves the background color. More...
IlvColorPattern *	getColorPattern () const
	Retrieves the color pattern. More...
IlString	getCssElementName () const override
	Returns the DOM element name of this stylable object. More...
virtual IlvDisplay *	getDisplay () const
	Retrieves the IlvDisplay instance. More...
IlvFillRule	getFillRule () const
	Retrieves the fill rule. More...
IlvFillStyle	getFillStyle () const
	Retrieves the fill style. More...
IlvFont *	getFont () const
	Retrieves the font. More...
IlvColor *	getForeground () const
	Retrieves the foreground color. More...
IlvGradientPattern *	getGradientPattern () const
	Retrieves the gradient pattern. More...
IlvLineStyle *	getLineStyle () const
	Retrieves the line style. More...
IlUShort	getLineWidth () const
	Retrieves the line width. More...
virtual IlvLookFeelHandler *	getLookFeelHandler () const
	Returns the look & feel handler used by this object. More...
virtual int	getLookupStringInputMethod (IlvEvent &event, char *bufferReturn, int bytesBuffer, int *statusReturn)
	Gets the preedit string from an input method. More...
IlvDrawMode	getMode () const
	Retrieves the draw mode. More...
IlBoolean	getOverwrite () const
	Retrieves the overwrite mode. More...
IlvPalette *	getPalette () const
	Retrieves the internal palette value. More...
IlvPattern *	getPattern () const
	Retrieves the pattern. More...
IlvDisplay *	getStylableDisplay () const override
	Returns the display for this object. More...
IlString	getStylableName () const override
	Returns the name of this object. More...
IlvStylist *	getStylist () const override
	Returns the stylist for this object. This is the parent stylist that actually sets the style, meaning first stylist with hasStylingApplied() == true. More...
virtual void	invert (IlBoolean=IlFalse)
	Highlights the object. More...
virtual void	registerInputMethod () const
	Controls the connection of a graphic object to an input method. More...
virtual void	setAlpha (IlvIntensity)
	Sets the alpha value of the object. More...
virtual void	setAntialiasingMode (IlvAntialiasingMode)
	Sets the anti-aliasing mode of the object. More...
virtual void	setArcMode (IlvArcMode)
	Sets the arc mode of the object. More...
virtual void	setBackground (IlvColor *)
	Sets the background color of the object. More...
virtual void	setColorPattern (IlvColorPattern *)
	Sets the color pattern of the object. More...
virtual void	setFillRule (IlvFillRule)
	Sets the fill rule of the object. More...
virtual void	setFillStyle (IlvFillStyle)
	Sets the fill style of the object. More...
virtual void	setFocusValuesInputMethod (IlUShort count, const IlvImValue *values) const
	Controls the interaction between a simple graphic object and an input method. More...
virtual void	setForeground (IlvColor *)
	Sets the foreground color of the object. More...
virtual void	setGradientPattern (IlvGradientPattern *)
	Sets the gradient pattern of the object. More...
virtual void	setHolder (IlvGraphicHolder *)
	Sets the object's holder. More...
virtual void	setLineStyle (IlvLineStyle *)
	Sets the line style of the object. More...
virtual void	setLineWidth (IlUShort)
	Sets the line width of the object. More...
virtual void	setMode (IlvDrawMode)
	Sets the drawing mode of the object temporarily. More...
virtual void	setOverwrite (IlBoolean)
	Sets an overwrite mode that modifies how the drawing member functions operate. More...
virtual void	setPalette (IlvPalette *palette)
	Sets the internal palette. More...
virtual void	setPattern (IlvPattern *)
	Sets the pattern of the object. More...
virtual void	setValuesInputMethod (IlUShort count, const IlvImValue *values) const
	Controls the interaction between a graphic object and an input method. More...
virtual void	unRegisterInputMethod () const
	Controls the disconnection of a graphic object from an input method. More...
virtual void	unsetFocusInputMethod () const
	Controls the interaction between a graphic object and an input method. More...
Public Member Functions inherited from IlvGraphic
void	addCallback (const IlSymbol *callbackType, const IlSymbol *callbackName, const IlSymbol *script=0)
	Adds a callback function to a callback list. More...
void	addCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
	Adds a callback function to a callback list. More...
void	addCallback (const IlSymbol *callbackType, IlvGraphicCallback callbackName, IlAny data)
	Adds a callback function to a callback list. More...
void	addClassProperty (const IlSymbol *key, IlAny value)
	Adds a property to this object's class. More...
void	addProperty (const IlSymbol *key, IlAny value)
	Adds a specific property to the object. More...
void	addTag (const IlSymbol *tag)
	Adds a tag. More...
virtual void	apply (IlvApplyObject function, IlAny arg)
	Applies a function to objects that compose another object. More...
IlBoolean	applyAttribute (const char *attributeClassName, const char *value, IlAny checkData=0) const
	Applies attributes. More...
IlBoolean	applyAttribute (const char *attributeClassName, IlFloat value, IlAny checkData=0) const
	Applies attributes. More...
IlBoolean	applyAttribute (const char *attributeClassName, IlInt value, IlAny checkData=0) const
	Applies attributes. More...
virtual void	applyReferences (IlvApplyObject function, IlAny arg)
	Applies a function to objects that are referenced by another object. More...
virtual void	callCallbacks (const IlSymbol *callbackType)
	Calls every callback of a given type. More...
const char *	className () const
	Returns the class name of an object. More...
virtual void	computeFocusRegion (IlvRegion &r, const IlvTransformer *t=0) const
	Computes the region needed for the drawing of the focus. More...
IlBoolean	contains (const IlvPoint &p) const
	Checks whether a point is in the object. More...
virtual IlvGraphic *	copy () const =0
	Copies this object. More...
void	draw (IlvPort *dst, const IlvTransformer *t, const IlvRect *clip) const
	Draws a graphic object. More...
virtual void	drawFocus (IlvPort *dst, const IlvPalette *palette, const IlvTransformer *t=0, const IlvRegion *clip=0) const
	Draws additional drawings for an object that has the keyboard focus. More...
virtual void	getAccessors (const IlSymbol *const **, const IlvValueTypeClass *const **, IlUInt &) const
	Retrieves the list of available accessors of an object. More...
IlvGraphicCallback	getCallback () const
	Gets the main callback function. More...
IlvGraphicCallback	getCallback (const IlSymbol *callbackType) const
	Gets a callback. More...
IlAny	getCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName) const
	Gets a callback user data. More...
IlAny	getCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
	Gets a callback user data. More...
IlSymbol *	getCallbackName () const
	Gets the symbol that identifies the main callback. More...
IlSymbol *	getCallbackName (const IlSymbol *callbackType) const
	Gets the name of a callback. More...
virtual IlUInt	getCallbackTypes (const char *const **names, const IlSymbol *const **types) const
	Gets the number of register callback types for the object. More...
virtual IlvGraphic *	getChildAt (IlUInt index) const
	Returns the sub-object of the graphic object specified by index. More...
virtual IlvGraphic *	getChildByName (const char *name) const
	Returns the sub-object of the graphic object specified by a name. More...
virtual IlUInt	getChildCount () const
	Returns the number of children of this graphic object. More...
virtual IlInt	getChildIndex (const IlvGraphic *object) const
	Returns the index of the specified sub-object in this graphic object. More...
virtual IlvGraphic *const *	getChildren (IlUInt &count) const
	Returns an array containing the sub-objects of this graphic object. More...
virtual IlvClassInfo *	getClassInfo () const
	Gets class information. More...
IlAny	getClassProperty (const IlSymbol *key, IlBoolean checkParent=IlFalse) const
	Retrieves the indicated property value in the class of this object. More...
IlAny	getClientData () const
	Gets client data. More...
virtual const char *	getDefaultInteractor () const
	Gets the name of the default interactor for this object. More...
virtual IlvGraphicHolder *	getHolder () const
	Gets a pointer to an object's holder. More...
IlvInteractor *	getInteractor () const
	Returns the interactor associated with the current object. More...
const char *	getName () const
	Gets the name of the object. More...
IlvNamedProperty *	getNamedProperty (const IlSymbol *name) const
	Gets a named property. More...
IlSymbol *	getNextFocusGraphic () const
	Gets the next object in the focus chain. More...
IlSymbol *	getPreviousFocusGraphic () const
	Gets the previous object in the focus chain. More...
IlAny	getProperty (const IlSymbol *key) const
	Gets a property. More...
IlvSmartSet *	getSmartSet () const
	Gets the smart set object containing this graphic object. More...
const IlSymbol *const *	getTags (IlUInt &count) const
	Returns all the tags applied to this object. More...
IlvDim	h () const
	Gets the height value of the object. More...
void	h (IlvDim h)
	Sets the height value of the object. More...
IlBoolean	hasCallback (const IlSymbol *callbackType, const IlSymbol *callbackName) const
	Checks whether a callback function is in a callback list. More...
IlBoolean	hasCallback (const IlSymbol *callbackType, IlvGraphicCallback callback) const
	Checks whether a callback function is in a callback list. More...
IlBoolean	hasCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName) const
	Checks whether a callback function has user data. More...
IlBoolean	hasCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
	Checks whether a callback function has user data. More...
const IlvClassInfo *	hasClassProperty (const IlSymbol *key, IlBoolean s=IlFalse) const
	Checks for a class where the keyed property exists. More...
IlBoolean	hasProperty (const IlSymbol *key) const
	Checks whether the object has a particular property. More...
IlBoolean	hasTag (const IlSymbol *tag) const
	Checks whether the object has a specific tag. More...
IlBoolean	inside (const IlvRect &r) const
	Determines whether a rectangle is inside the bounding box. More...
IlBoolean	inside (const IlvRect &r, const IlvRect &tr, const IlvTransformer *t=0) const
	Determines whether an object with transformation applied is inside the bounding box. More...
IlBoolean	intersects (const IlvRect &r) const
	Checks whether a rectangle intersects the bounding box. More...
IlBoolean	intersects (const IlvRect &r, const IlvRect &tr, const IlvTransformer *t=0) const
	Checks whether a rectangle intersects the bounding box with transformation applied. More...
IlBoolean	isFirstFocusGraphic () const
	Checks whether the object is first in the focus chain. More...
IlBoolean	isFocusable () const
	Checks whether the object can receive the keyboard focus. More...
IlBoolean	isInSmartSet () const
	Checks whether a graphic object belongs to a smart set. More...
IlBoolean	isLastFocusGraphic () const
	Checks whether the object is last in the focus chain. More...
IlBoolean	isSensitive () const
	Checks whether the object is sensitive. More...
IlBoolean	isSubtypeOf (const char *parentClass) const
	Checks whether this object's class is a subclass of a given parent class. More...
IlBoolean	isSubtypeOf (const IlvClassInfo *classInfo) const
	Checks whether this object's class is a subclass. More...
void	move (const IlvPoint &p)
	Moves the graphic object. More...
virtual void	move (IlvPos x, IlvPos y)
	Moves the graphic object. More...
void	moveResize (const IlvRect &size)
	Moves and resizes a graphic object. More...
virtual IlBoolean	needsInputContext () const
	Indicates whether the graphic instance can connect to an input method for locale dependent input. More...
virtual void	print (std::ostream &out, int level=0) const
	Prints for debugging purposes. More...
void	removeCallback (const IlSymbol *callbackType, const IlSymbol *callbackName)
	Removes a callback function from a callback list. More...
void	removeCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
	Removes a callback function from a callback list. More...
IlBoolean	removeClassProperty (const IlSymbol *key)
	Removes a property from this object's class. More...
void	removeInteractor ()
	Removes the interactor from the current object. More...
IlvNamedProperty *	removeNamedProperty (IlSymbol *name)
	Removes a named property from the object. More...
IlBoolean	removeProperty (const IlSymbol *key)
	Removes a property from the object. More...
void	removeTag (const IlSymbol *tag)
	Removes a tag. More...
IlBoolean	replaceClassProperty (const IlSymbol *key, IlAny value)
	Replaces a property in this object's class. More...
IlBoolean	replaceProperty (const IlSymbol *key, IlAny value)
	Replaces a property. More...
virtual void	resize (IlvDim newW, IlvDim newH)
	Resizes a graphic object. More...
virtual void	rotate (const IlvPoint &center, IlFloat angle)
	Rotates a graphic object. More...
virtual void	scale (IlFloat zoomX, IlFloat zoomY)
	Scales the graphic object. More...
void	setCallback (const IlSymbol *callbackType, const IlSymbol *callbackName, const IlSymbol *script=0)
	Removes all previously set callbacks. More...
void	setCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
	Sets a new callback. More...
void	setCallback (const IlSymbol *callbackType, IlvGraphicCallback callbackName, IlAny data)
	Removes all previously set callbacks. More...
void	setCallback (IlvGraphicCallback callback, IlAny data)
	Sets the main callback function. More...
void	setCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName, IlAny data)
	Sets the callback user data for a callback function. More...
void	setCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback, IlAny data)
	Sets the callback user data for a callback function. More...
void	setCallbackName (const IlSymbol *callbackName)
	Sets the symbol that identifies the main callback. More...
void	setClientData (IlAny clientData)
	Sets client data. More...
void	setFirstFocusGraphic ()
	Sets the object to be first in the focus chain.
void	setFocusable (IlBoolean value)
	Set the focusable state of the object. More...
IlBoolean	setInteractor (const char *name)
	Attaches an interactor to this graphic object. More...
IlBoolean	setInteractor (IlvInteractor *inter)
	Attaches an interactor to the current object. More...
void	setLastFocusGraphic ()
	Sets the object to be last in the focus chain.
virtual void	setName (const char *name)
	Sets the name of the object. More...
IlvNamedProperty *	setNamedProperty (IlvNamedProperty *property)
	Sets a named property on the object. More...
virtual void	setNeedsInputContext (IlBoolean val)
	Specifies whether the graphic object should have locale dependent input. More...
void	setNextFocusGraphic (IlSymbol *name)
	Sets the object to be next in the focus chain. More...
void	setPreviousFocusGraphic (IlSymbol *name)
	Sets an object as previous in the focus chain. More...
void	setProperty (const IlSymbol *key, IlAny value)
	Sets a property of the object to a value. More...
virtual void	setSensitive (IlBoolean value)
	Sets the sensitivity of the object. More...
virtual void	symmetry (IlvDirection axis)
	Flips a graphic object. More...
virtual void	translate (IlvPos dx, IlvPos dy)
	Applies a transformation function on a graphic object. More...
IlvDim	w () const
	Gets the width value of the object. More...
void	w (IlvDim w)
	Sets the width value of the object. More...
virtual void	write (IlvOutputFile &output) const =0
	Writes an object description to a file. More...
IlvPos	x () const
	Gets the x coordinate value of the object. More...
void	x (IlvPos x)
	Sets the x coordinate value of the object. More...
IlvPos	y () const
	Gets the y coordinate value of the object. More...
void	y (IlvPos y)
	Sets the y coordinate value of the object. More...
Public Member Functions inherited from IlvValueInterface
virtual IlBoolean	applyValue (const IlvValue &value)
	Apply an accessor. More...
virtual IlBoolean	changeValue (const IlvValue &val)
	Changes the value of an accessor. More...
virtual IlBoolean	changeValues (const IlvValue *values, IlUShort count=0)
	Changes several accessor values simultaneously. More...
virtual IlvValue &	queryValue (IlvValue &val) const
	Retrieves an accessor value. More...
virtual void	queryValues (IlvValue *values, IlUShort count) const
	Retrieves multiple accessor values simultaneously. More...
Public Member Functions inherited from IlvStylable
	IlvStylable ()
	Constructor.
void	addCssElementClass (const IlString &cssClass)
	Appends a class to the DOM class list of this stylable object. More...
void	addCssElementClass (const IlStringList &cssClasses)
	Appends a list of classes to the DOM class list of this stylable object. More...
IlvStylable *	getChildStylable (const IlString &cssElementName) const
	Returns child stylable with specified css element name. Returns null if the child is not found. More...
virtual IlString	getCssElementClass () const
	Returns the DOM classes of this stylable object as a space separated string. <cssElement class="cssClass1 cssClass2"> More...
virtual const IlStringList &	getCssElementClassList () const
	Returns the DOM classes of this stylable object. <cssElement class="cssClass1 cssClass2"> More...
IlString	getCssElementId () const
	Returns the DOM element id of this stylable object. <cssElement id="cssId"> More...
virtual void	getOuterStylableSize (IlvDim &w, IlvDim &h) const
	Returns the size of the outer stylable if any. More...
virtual IlvStylable *	getStylableParent () const
	Returns the parent of this object in the style hierarchy. More...
virtual void	getStylableSize (IlvDim &w, IlvDim &h) const
	Returns the size of this object. More...
void	readStyleInfo (std::istream &stream)
void	setCssElementClass (const IlString &cssClass)
	Sets the DOM class of this stylable object. More...
void	setCssElementClass (const IlStringList &cssClasses)
	Sets the DOM classes of this stylable object. More...
void	setCssId (const IlString &id)
	Sets the object's css styling id. The id is initially the same as the name property of the object, but can be overridden using this function. More...
virtual void	setupDefaultCssStyle ()
	virtual functions used to setupDefaultStyle. Override this to change default styling

Additional Inherited Members
Static Public Member Functions inherited from IlvGraphic
static void	AddProperty (const IlSymbol *key, IlAny value)
	Adds a property to this object's class. More...
static void	AddToCallbackTypeList (IlUInt &count, const char *const **names, const IlSymbol *const **types, const char *newName, const IlSymbol *newType)
	Adds a callback to a list. More...
static void	AllowZoom (IlBoolean az)
	Sets or inhibits zooming. More...
static IlvClassInfo *	ClassInfo () const
	Gets class information. More...
static IlAny	GetProperty (const IlSymbol *key, IlBoolean checkSuperClass=IlFalse)
	Retrieves the property value associated with the key in this object's class. More...
static const IlvClassInfo *	HasProperty (const IlSymbol *key, IlBoolean checkSuperClass=IlFalse)
	Checks for the existence of a property for this object's class hierarchy. More...
static IlBoolean	IsZoomAllowed ()
	Checks whether zoomable objects can display themselves when zooming out. More...
static IlvGraphic *	read (IlvInputFile &file, IlvPalette *palette)
	Reads an object description from a file. More...
static IlBoolean	RemoveProperty (const IlSymbol *key)
	Removes a property from this object's class. More...
static IlBoolean	ReplaceProperty (const IlSymbol *key, IlAny value)
	Replaces a property in this object's class. More...
Static Public Member Functions inherited from IlvStylable
static void	DisableCssDom ()
	Disables any further DOM additions. More...

Detailed Description

Graphic class.

Library: views

An IlvListLabel object appears as a vertical list of strings, so that it looks like a series of lines of text.

- IlvListLabel -

See also

IlvLabel.

Constructor & Destructor Documentation

IlvListLabel() [1/2]

IlvListLabel::IlvListLabel	(	IlvDisplay *	display,
		const IlvPoint &	position,
		IlUInt	count,
		const char *const *	labels,
		IlvPalette *	palette = 0
	)

Initializes a new IlvListLabel from an array of strings.

Parameters

display	The display instance.
position	The position of the graphic object bounding box.
count	The number of strings in the array.
labels	The array of strings. The strings and the array are copied.
palette	The palette used to draw the object.

IlvListLabel() [2/2]

IlvListLabel::IlvListLabel	(	IlvDisplay *	display,
		IlUInt	count,
		const IlvPoint &	position,
			...
	)

Creates an IlvListLabel graphic object from a series of strings.

The variable part of the parameter list must contain exclusively count character strings. The strings are copied.

Parameters

display	The display instance.
count	The number of strings given in parameter.
position	The position of the graphic object bounding box.

Member Function Documentation

addLabel()

void IlvListLabel::addLabel

(

const char *

label

)

Adds a string.

Adds the specified string to the array of drawn strings at the last position.

Parameters

label

The string to add. The string is copied.

align() [1/2]

IlvPosition IlvListLabel::align

(

)

const

Returns the alignment of the strings.

Returns

The alignment of the drawn strings.

align() [2/2]

IlvPosition IlvListLabel::align

(

IlvPosition

align

)

Sets the alignment of the strings.

Changes the alignment of the drawn strings.

Parameters

align

Specifies the alignment.

Returns

The value of the parameter align.

applyTransform()

virtual void IlvListLabel::applyTransform ( const IlvTransformer *  t )

virtual

Applies a transformation function to the graphic object.

Applies the transformer t to the shape of the object. Unless the transformation is a scaling operation, the result of applying it to certain objects can be insignificant. For example, applying a non-scaling transformer to an IlvRectangle object is meaningless, since the rectangle remains a rectangle. On the other hand, meaningful transformations can be applied to objects that are instances of types such as IlvLine or IlvPolyPoints.

Note

applyTransform() is one of the most important method to be rewritten for classes derived from IlvGraphic, since it is called by the resize(), move(), moveResize(), scale(), etc., methods.

Parameters

t	The transformer value. If 0, no transformation is performed.

Implements IlvGraphic.

boundingBox()

virtual void IlvListLabel::boundingBox ( IlvRect &  bbox, const IlvTransformer *  t = 0  ) const

virtual

Retrieves the bounding box of the graphic object.

Sets bbox, the rectangle reference parameter, to be the bounding box of the object. Since the object can appear within a transformed environment (for example, in a multiview editor), an IlvTransformer object occurs as an optional parameter in order to compute the bounding box in the coordinate system of the transformed environment.

Parameters

bbox	The bounding box to be set.
t	A transformer value or 0 if there is no transformation.

Implements IlvGraphic.

contains()

IlBoolean IlvListLabel::contains ( const IlvPoint &  p, const IlvPoint &  tp, const IlvTransformer *  t = 0  ) const

virtual

Checks whether a point is in the object.

Checks whether the coordinates are located in the shape of this object. A transformation parameter allows you to use the view's coordinate system for this test.

Parameters

p	The point to be tested.
tp	The transformed point obtained by applying the transformer t to the point p.
t	A transformer value, or 0 if there is no transformation.

Returns

IlTrue when the point p lies inside the outline of the object.

Reimplemented from IlvGraphic.

draw()

virtual void IlvListLabel::draw ( IlvPort *  dst, const IlvTransformer *  t = 0, const IlvRegion *  clip = 0  ) const

virtual

Draws the graphic object.

Draws the object in the given IlvPort using the transformer t.

Parameters

dst	The destination port this object is drawn onto.
t	The transformer value. If 0, no transformation is performed.
clip	The clipping region, relative to the transformed object, or 0 if none.

Implements IlvGraphic.

getCardinal()

IlUInt IlvListLabel::getCardinal

(

)

const

Returns the number of label strings.

Returns

The number of strings drawn by the graphic object.

getLabel()

const char* IlvListLabel::getLabel

(

IlUInt

index

)

const

Returns the string at a given index.

Returns

The string stored at the given index in the internal array of strings stored by the graphic object.

Parameters

index

The index in the array of strings.

Note

The returned string must not be modified or deleted.

getLabels()

const char* const* IlvListLabel::getLabels

(

IlUInt &

count

)

const

Returns the array of strings.

Returns

The array of strings drawn by the graphic object. The returned array and the strings must not be deleted or modified.

Parameters

count

Used to return the number of strings in the array.

getSpacing()

IlvDeltaPos IlvListLabel::getSpacing

(

)

const

Returns the vertical spacing between lines.

Returns

The vertical spacing between drawn strings.

getText()

const char* IlvListLabel::getText

(

)

const

Returns the contents of an array of strings.

Returns

A string composed of all the label strings drawn by the graphic object, each separated by a "`\n`" character.

inside()

IlBoolean IlvListLabel::inside ( const IlvRegion &  r, const IlvTransformer *  t = 0  ) const

virtual

Determines whether an object with transformation applied is inside the bounding box.

Determines whether an object with transformation applied is inside the bounding box.

Parameters

r	The region to be tested.
t	A transformer value, or 0 if there is no transformation.

Returns

IlTrue when the object, drawn with the transformer t, covers completely the region r. This member function returns IlFalse when this is not the case. That means that it returns IlTrue if all rectangles that define the region completely lie inside the object.

Reimplemented from IlvGraphic.

intersects()

IlBoolean IlvListLabel::intersects ( const IlvRegion &  r, const IlvTransformer *  t = 0  ) const

virtual

Checks whether a region intersects the bounding box with transformation applied.

Checks whether a region intersects the bounding box with transformation applied.

Parameters

r	The region to be tested.
t	A transformer value, or 0 if there is no transformation.

Returns

IlTrue when the region r overlaps the transformed object (if t is not 0) and IlFalse when this is not the case.

Reimplemented from IlvGraphic.

removeLabel()

void IlvListLabel::removeLabel

(

IlUInt

index

)

Removes the string at a given index.

Removes the label at the specified index from the array of drawn strings.

setFont()

virtual void IlvListLabel::setFont ( IlvFont *  font )

virtual

Sets the font of the object.

Parameters

font	The new font.

Reimplemented from IlvSimpleGraphic.

setLabel()

void IlvListLabel::setLabel	(	const char *	label,
		IlUInt	index
	)

Sets a label string at a given index.

Replaces the string at the given index by a new one. The previous one is deleted.

Parameters

label	The new label string. The string is copied.
index	Specifies the index in the internal array of strings.

setLabels()

void IlvListLabel::setLabels	(	const char *const *	labels,
		IlUInt	count,
		IlBoolean	copy = IlTrue
	)

Sets the array of strings.

Replaces the array of strings by a new one. The old array and its strings are deleted.

Parameters

labels	The new array of strings.
count	The number of strings in the new array.
copy	If IlTrue, a copy of the strings and a copy of the array holding them is made. Otherwise, the graphic object directly uses the array of strings passed in argument.

setSpacing()

void IlvListLabel::setSpacing

(

IlvDeltaPos

spacing

)

Sets the vertical spacing between lines.

Changes the vertical spacing between drawn strings.

Parameters

spacing

The new spacing value.

setText()

void IlvListLabel::setText

(

const char *

text

)

Resets the graphic object with a multiline string.

Resets the object by extracting from text the substrings separated by a "`\n`" character.

whichContains()

IlInt IlvListLabel::whichContains	(	const IlvPoint &	p,
		const IlvTransformer *	t = 0
	)		const

Returns the index of the string containing a given point.

Returns

-1 if the point is not in the graphic object. Otherwise, it returns the index of the drawn string containing the point.

Parameters

p	The point, possibly transformed.
t	If a transformer is specified, it is applied to the graphic object before testing if it contains the point.

zoomable()

virtual IlBoolean IlvListLabel::zoomable ( ) const

virtual

Indicates whether the graphic object is zoomable.

Returns

IlFalse. Subclasses can implement a different behavior allowing the graphic object to zoom, in which case the method must be redefined to return IlFalse.

Reimplemented from IlvGraphic.