Graphic class that displays a time scale. More...

#include <ilviews/graphics/timescale.h>

Inheritance diagram for IlvTimeScale:

Public Member Functions
	IlvTimeScale (IlvDisplay display, const IlvRect &drawrect, IlvPalette palette=0)
	Constructor. More...

virtual void	addRow (IlvTimeScaleRow *row)
	Append the specified `IlvTimeScaleRow` to the scale. More...

void	applyTransform (const IlvTransformer *)
	Applies a transformation function to the graphic object. More...

virtual void	boundingBox (IlvRect &r, const IlvTransformer *t=0) const
	Retrieves the bounding box of the graphic object. More...

IlvTimeScalePaintContext *	createPaintContext (IlDate start, IlvDuration duration, IlvRect viewport)
	Create a `IlvTimeScalePaintContext`. More...

void	draw (IlvPort , const IlvTransformer =0, const IlvRegion *=0) const
	Draws the graphic object. More...

IlCalendar *	getCalendar ()
	Get the internal calendar.

IlCalendar *	getCalendar (IlDate time)
	Get the internal calendar set to the specified time. More...

virtual IlInt	getLocation (IlDate time)
	Get the x position corresponding to the specified time. More...

virtual IlInt	getLocation (IlDate time, const IlvTimeScalePaintContext &)
	Get the x position corresponding to the specified time in the specified paint context. More...

virtual IlDate	getMaxVisibleTime () const
	Returns the maximum time that the time scrollable can show. More...

virtual IlDate	getMinVisibleTime () const
	Returns the minimum time that the time scrollable can show. More...

IlDouble	getOffset () const
	Get the scale offset.

IlvTimeScalePaintContext *	getPaintContext ()
	Gets the scales' cached `IlvTimeScalePaintContext`. More...

virtual IlvTimeScaleRow *	getRow (IlInt index) const
	Get the `IlvTimeScaleRow` at a specified index. More...

virtual IlDate	getTime (IlInt x)
	Get the time that is under the x position in the component. More...

IlvTimeConverter *	getTimeConverter () const

virtual IlvDuration	getVisibleDuration () const
	Returns the duration of the time interval displayed by the time scrollable. More...

virtual IlvTimeInterval	getVisibleInterval () const
	Returns the time interval displayed by the scale. More...

virtual IlDate	getVisibleTime () const
	Returns the beginning of the time interval displayed by the time scrollable. More...

IlDouble	getZoomFactor () const
	Get the scale zoom factor.

virtual void	hideRow (IlvTimeScaleRow *row)
	Hide the specified row. More...

virtual void	hideRow (IlInt index)
	Hide the specified row. More...

IlBoolean	isLabelVisible () const
	Returns whether the labels should be visible. More...

IlBoolean	isSeparatorVisible () const
	Returns whether the separators should be visible. More...

virtual void	move (IlvPos x, IlvPos y)
	Internal methods.

virtual IlBoolean	removeRow (IlvTimeScaleRow *row)
	Remove a row from the `IlvTimeScale` object. More...

void	setLabelVisible (IlBoolean visible)
	Specifies whether the labels should be visible. More...

virtual void	setMaxVisibleTime (IlDate d)
	Sets the maximum time that the time scrollable can show. More...

virtual void	setMinVisibleTime (IlDate d)
	Sets the minimum time that the time scrollable can show. More...

virtual void	setRow (IlInt index, IlvTimeScaleRow *row)
	Change the `IlvTimeScaleRow` object at a specified index. More...

void	setSeparatorVisible (IlBoolean visible)
	Specifies whether the separators should be visible. More...

void	setTimeConverter (IlvTimeConverter *t)
	Sets the convertor of the time scale. More...

virtual void	setVisibleDuration (IlvDuration duration)
	Sets the duration of the time interval displayed by the time scrollable. More...

virtual void	setVisibleInterval (IlDate time, IlvDuration duration)
	Sets the time interval displayed by the scale. More...

virtual void	setVisibleTime (IlDate time)
	Sets the beginning of the time interval displayed by the time scrollable. More...

virtual void	showRow (IlvTimeScaleRow *row)
	Show the specified row. More...

virtual void	showRow (IlInt index)
	Show the specified row. More...

Public Member Functions inherited from IlvSimpleGraphic
	IlvSimpleGraphic (IlvDisplay display, IlvPalette palette=0)
	Constructor. More...

virtual	~IlvSimpleGraphic ()
	Destructor. More...

virtual void	applyResources (const char storageName, const char storageClassName, const char objectName, const char objectClassName, IlvDisplay *display=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...

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...

virtual void	invert (IlBoolean temp=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 alpha)
	Sets the alpha value of the object. More...

virtual void	setAntialiasingMode (IlvAntialiasingMode mode)
	Sets the anti-aliasing mode of the object. More...

virtual void	setArcMode (IlvArcMode am)
	Sets the arc mode of the object. More...

virtual void	setBackground (IlvColor *c)
	Sets the background color of the object. More...

virtual void	setColorPattern (IlvColorPattern *b)
	Sets the color pattern of the object. More...

virtual void	setFillRule (IlvFillRule fr)
	Sets the fill rule of the object. More...

virtual void	setFillStyle (IlvFillStyle f)
	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	setFont (IlvFont *f)
	Sets the font of the object. More...

virtual void	setForeground (IlvColor *c)
	Sets the foreground color of the object. More...

virtual void	setGradientPattern (IlvGradientPattern *g)
	Sets the gradient pattern of the object. More...

virtual void	setHolder (IlvGraphicHolder *holder)
	Sets the object's holder. More...

virtual void	setLineStyle (IlvLineStyle *style)
	Sets the line style of the object. More...

virtual void	setLineWidth (IlUShort width)
	Sets the line width of the object. More...

virtual void	setMode (IlvDrawMode m)
	Sets the drawing mode of the object temporarily. More...

virtual void	setOverwrite (IlBoolean o)
	Sets an overwrite mode that modifies how the drawing member functions operate. More...

virtual void	setPalette (IlvPalette *palette)
	Sets the internal palette to the given `palette` value. More...

virtual void	setPattern (IlvPattern *p)
	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, IlvGraphicCallback callback)
	Adds a callback function to a callback list. More...

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, 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, IlInt 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, const char 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 IlBoolean	applyValue (const IlvValue &val)
	Apply an accessor. More...

virtual void	callCallbacks (const IlSymbol *callbackType)
	Calls every callback of a given type. More...

virtual IlBoolean	changeValue (const IlvValue &val)
	Changes the value of an accessor. More...

virtual IlBoolean	changeValues (const IlvValue *values, IlUShort count)
	Changes several accessor values simultaneously. 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...

virtual IlBoolean	contains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
	Checks whether a point is in the object. 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 accessors, const IlvValueTypeClass const **types, IlUInt &count) const
	Retrieves the list of available accessors of an object. More...

IlvGraphicCallback	getCallback (const IlSymbol *callbackType) const
	Gets a callback. More...

IlvGraphicCallback	getCallback () const
	Gets the main callback function. More...

IlAny	getCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
	Gets a callback user data. More...

IlAny	getCallbackData (const IlSymbol callbackType, const IlSymbol callbackName) const
	Gets a callback user data. More...

IlSymbol *	getCallbackName (const IlSymbol *callbackType) const
	Gets the name of a callback. More...

IlSymbol *	getCallbackName () const
	Gets the symbol that identifies the main 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 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 a specified graphic 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, IlvGraphicCallback callback) const
	Checks whether a callback function is in a callback list. More...

IlBoolean	hasCallback (const IlSymbol callbackType, const IlSymbol callbackName) const
	Checks whether a callback function is in a callback list. More...

IlBoolean	hasCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
	Checks whether a callback function has user data. More...

IlBoolean	hasCallbackData (const IlSymbol callbackType, const IlSymbol callbackName) 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...

virtual IlBoolean	inside (const IlvRegion &r, const IlvTransformer *t=0) const
	Determines whether an object with transformation applied 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	inside (const IlvRect &r) const
	Determines whether a rectangle is inside the bounding box. More...

virtual IlBoolean	intersects (const IlvRegion &r, const IlvTransformer *t=0) const
	Checks whether a region intersects the bounding box with transformation applied. 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	intersects (const IlvRect &r) const
	Checks whether a rectangle intersects the bounding box. 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 or not. 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...

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 (ILVSTDPREF ostream &out, int level=0) const
	Prints for debugging purposes. More...

virtual IlvValue &	queryValue (IlvValue &val) const
	Retrieves the value of an accessor. More...

virtual void	queryValues (IlvValue *values, IlUShort count) const
	Retrieves multiple accessor values simultaneously. More...

void	removeCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
	Removes a callback function from a callback list. More...

void	removeCallback (const IlSymbol callbackType, const IlSymbol callbackName)
	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, IlvGraphicCallback callback)
	Sets a new callback. 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, 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, IlvGraphicCallback callback, IlAny data)
	Sets the callback user data for a callback function. More...

void	setCallbackData (const IlSymbol callbackType, const IlSymbol callbackName, 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 (IlvInteractor *inter)
	Attaches an interactor to the current object. More...

IlBoolean	setInteractor (const char *name)
	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...

virtual IlBoolean	zoomable () const
	Checks whether this object is zoomable. More...

Protected Member Functions
void	shiftRows (IlInt index, IlvDim height)
	Shift rows vertically of height. More...

Friends
class	IlvTimeScalePaintContext

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...

Detailed Description

Graphic class that displays a time scale.

Library: views

The IlvTimeScale class is a time scale component that contains several IlvTimeScaleRow objects. Each row represents a particular time unit and is responsible for drawing itself. The rows are not true UI components, but behave like renderers.

To scroll through the scale or to zoom on it when changing the time value and the visible duration, a new IlvTimeConverter object must be set for the scale.

See Also: setTimeConverter

Constructor & Destructor Documentation

IlvTimeScale::IlvTimeScale	(	IlvDisplay *	display,
		const IlvRect &	drawrect,
		IlvPalette *	palette = `0`
	)

Constructor.

Creates a new IlvTimeScale that initially contains no rows. By default, the time scale uses an IlvLinearTimeConverter. The time scale's time converter can be set by calling the setTimeConverter method.

Parameters

display	The display this graphic will use.
drawrect	The rectangle the scale will be drawn into.
palette	The palette to use, or 0 to use the default palette.

Member Function Documentation

virtual void IlvTimeScale::addRow ( IlvTimeScaleRow * row )

virtual

Append the specified IlvTimeScaleRow to the scale.

To see the modification, you must redraw the object.

Parameters

row	The row to be added.

See Also: removeRow

void IlvTimeScale::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.

Warning: [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.

virtual void IlvTimeScale::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. When there is no transformation, t is set to 0.

Parameters

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

Implements IlvGraphic.

IlvTimeScalePaintContext* IlvTimeScale::createPaintContext	(	IlDate	start,
		IlvDuration	duration,
		IlvRect	viewport
	)

Create a IlvTimeScalePaintContext.

Creates a IlvTimeScalePaintContext so that the time scale paints the specified time interval into the specified view port. Caller owns the returned object.

Parameters

start	The begin of the visible time interval.
duration	The duration of the visible time interval.
viewport	The rectangle defining the position the time scale to paint to.

Returns: The paint context.

void IlvTimeScale::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 which might have the value 0. The clip parameter, which can also be 0, represents the clipping region relative to the transformed object.

Parameters

dst	The destination port.
t	The transformer value. If 0, no transformation is performed.
clip	The clipping region, or 0 if none.

Implements IlvGraphic.

IlCalendar* IlvTimeScale::getCalendar ( IlDate time )

Get the internal calendar set to the specified time.

Parameters

time	The time to set the calendar to.

virtual IlInt IlvTimeScale::getLocation ( IlDate time )

virtual

Get the x position corresponding to the specified time.

Parameters

time The time.

Returns: the coordinate corresponding to the IlDate.

virtual IlInt IlvTimeScale::getLocation	(	IlDate	time,
		const IlvTimeScalePaintContext &
	)

virtual

Get the x position corresponding to the specified time in the specified paint context.

Parameters

time	The time.
context	The paint context.

Returns: The x position.

virtual IlDate IlvTimeScale::getMaxVisibleTime ( ) const

virtual

Returns the maximum time that the time scrollable can show.

Returns: The maximum visible time.

See Also: setMaxVisibleTime

Implements IlvTimeScrollable.

virtual IlDate IlvTimeScale::getMinVisibleTime ( ) const

virtual

Returns the minimum time that the time scrollable can show.

Returns: The minimum visible time.

See Also: setMinVisibleTime

Implements IlvTimeScrollable.

IlvTimeScalePaintContext* IlvTimeScale::getPaintContext ( )

Gets the scales' cached IlvTimeScalePaintContext.

Gets the cached IlvTimeScalePaintContext used to paint the time scale on screen.

Caller owns the returned object

Returns: The cached paint context.

virtual IlvTimeScaleRow* IlvTimeScale::getRow ( IlInt index ) const

virtual

Get the IlvTimeScaleRow at a specified index.

Parameters

index The index of the returned row. The index value must be valid (not greater than the actual number of rows).

Returns: the IlvTimeScaleRow.

virtual IlDate IlvTimeScale::getTime ( IlInt x )

virtual

Get the time that is under the x position in the component.

Parameters

x	The x position in the component.

Returns: the IlDate corresponding to the position.

IlvTimeConverter* IlvTimeScale::getTimeConverter ( ) const

Returns the IlvTimeConverter object of this scale.

virtual IlvDuration IlvTimeScale::getVisibleDuration ( ) const

virtual

Returns the duration of the time interval displayed by the time scrollable.

See Also: setVisibleDuration

Implements IlvTimeScrollable.

virtual IlvTimeInterval IlvTimeScale::getVisibleInterval ( ) const

virtual

Returns the time interval displayed by the scale.

See Also: setVisibleInterval

Implements IlvTimeScrollable.

virtual IlDate IlvTimeScale::getVisibleTime ( ) const

virtual

Returns the beginning of the time interval displayed by the time scrollable.

See Also: setVisibleTime

Implements IlvTimeScrollable.

virtual void IlvTimeScale::hideRow ( IlvTimeScaleRow * row )

virtual

Hide the specified row.

Parameters

row	The row to be hidden.

virtual void IlvTimeScale::hideRow ( IlInt index )

virtual

Hide the specified row.

Parameters

row	The index of the row to be hidden.

IlBoolean IlvTimeScale::isLabelVisible ( ) const

Returns whether the labels should be visible.

Returns: Whether the labels should be visible.

IlBoolean IlvTimeScale::isSeparatorVisible ( ) const

Returns whether the separators should be visible.

Returns: IlTrue if the separators should be visible, otherwise IlFalse.

virtual IlBoolean IlvTimeScale::removeRow ( IlvTimeScaleRow * row )

virtual

Remove a row from the IlvTimeScale object.

To see the modification, you must redraw the object.

Parameters

row	The row to be removed.

Returns: IlTrue if the specified row was found in the object, IlFalse otherwise.

void IlvTimeScale::setLabelVisible ( IlBoolean visible )

Specifies whether the labels should be visible.

Parameters

visible IlTrue if the labels should be visible or IlFalse if they should not.

virtual void IlvTimeScale::setMaxVisibleTime ( IlDate d )

virtual

Sets the maximum time that the time scrollable can show.

The current visible time and duration are trimmed to fit the new min-max interval by calling the IlvTimeScrollUtil::trimInterval method.

Parameters

d	The maximum visible time.

See Also: getMaxVisibleTime; getVisibleDuration

Implements IlvTimeScrollable.

virtual void IlvTimeScale::setMinVisibleTime ( IlDate d )

virtual

Sets the minimum time that the time scrollable can show.

The current visible time and duration are trimmed to fit the new min-max interval by calling the IlvTimeScrollUtil::trimInterval method.

Parameters

d	The minimum visible time.

See Also: getMinVisibleTime; getVisibleDuration

Implements IlvTimeScrollable.

virtual void IlvTimeScale::setRow	(	IlInt	index,
		IlvTimeScaleRow *	row
	)

virtual

Change the IlvTimeScaleRow object at a specified index.

Parameters

index	The index of the changed row. The index value must be valid (not greater than the actual number of rows).
row	The new `IlvTimeScaleRow`.

Reimplemented in IlvCalendarScale.

void IlvTimeScale::setSeparatorVisible ( IlBoolean visible )

Specifies whether the separators should be visible.

Parameters

visible IlTrue if the separators should be visible or IlFalse if they shoud not.

void IlvTimeScale::setTimeConverter ( IlvTimeConverter * t )

Sets the convertor of the time scale.

This method can be used to change the IlvTimeConverter object of this scale.

This object allows you to draw the scale correctly by converting time value to units on the screen.

Warning: [note] The scale takes ownership of the time converter, it will be deleted along with the scale or when a new time converter is set.

Parameters

timeConverter The new IlvTimeConverter object.

virtual void IlvTimeScale::setVisibleDuration ( IlvDuration duration )

virtual

Sets the duration of the time interval displayed by the time scrollable.

The specified duration is compared against the min and max visible times and is trimmed if necessary by calling the IlvTimeScrollUtil::trimInterval method. If you are changing both the visible time and duration, it is preferable to use the setVisibleInterval method instead.

Parameters

duration The new duration value.

See Also: getVisibleDuration; getMinVisibleTime; getMaxVisibleTime

Implements IlvTimeScrollable.

Reimplemented in IlvCalendarScale.

virtual void IlvTimeScale::setVisibleInterval	(	IlDate	time,
		IlvDuration	duration
	)

virtual

Sets the time interval displayed by the scale.

The specified duration is compared against the min and max visible times and is trimmed if necessary by calling the IlvTimeScrollUtil::trimInterval method.

Parameters

time	The new time value.
duration	The new duration value.

See Also: getMinVisibleTime; getMaxVisibleTime

Implements IlvTimeScrollable.

Reimplemented in IlvCalendarScale.

virtual void IlvTimeScale::setVisibleTime ( IlDate time )

virtual

Sets the beginning of the time interval displayed by the time scrollable.

The specified time value is compared against the min and max visible times and is trimmed if necessary by calling the IlvTimeScrollUtil::trimInterval method. If you are changing both the visible time and duration, it is preferable to use the setVisibleInterval method instead.

Parameters

time	The new time value.

See Also: getVisibleTime; getMinVisibleTime; getMaxVisibleTime; setVisibleInterval

Implements IlvTimeScrollable.

void IlvTimeScale::shiftRows	(	IlInt	index,
		IlvDim	height
	)

protected

Shift rows vertically of height.

Parameters

index	The index of the first row to be shifted.
height	The height in pixel of which to shift the rows.

virtual void IlvTimeScale::showRow ( IlvTimeScaleRow * row )

virtual

Show the specified row.

Parameters

row	The row to be shown.

virtual void IlvTimeScale::showRow ( IlInt index )

virtual

Show the specified row.

Parameters

row	The index of the row to be shown.

Rogue Wave ViewsFoundation Package API Reference Guide

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Rogue Wave Views
Foundation Package API Reference Guide