IlvGraphicPane Class Reference

Pane class. More...

#include <ilviews/gadgets/panecont.h>

Inheritance diagram for IlvGraphicPane:

Public Member Functions
	IlvGraphicPane (const char *name, IlvGraphic *graphic, IlUShort margin=2, IlBoolean owner=IlTrue)
	Constructor. More...
virtual void	boundingBox (IlvRect &) const
	Returns the size and position of the pane. More...
IlvGraphic *	getObject () const
	Returns the graphic object encapsulated by the pane. More...
IlBoolean	isDoubleBuffering () const
	Tests the pane double buffering setting. More...
virtual void	moveResize (const IlvRect &)
	Moves and resizes the pane. More...
virtual void	setContainer (IlvPanedContainer *cont)
	Is called when the container of the pane changes. More...
virtual void	setDoubleBuffering (IlBoolean value)
	Sets double buffering. More...
virtual void	setFocus (IlvEvent *event=0)
	Gives the focus to the pane. More...
void	setObject (IlvGraphic *obj, IlBoolean owner=IlTrue)
	Sets the graphic object encapsulated by the pane. More...
Public Member Functions inherited from IlvPane
	IlvPane (const char *name)
	Constructor. More...
void	addListener (IlvPaneListener *listener)
	Adds a listener to the pane. More...
IlUShort	getBottomMargin () const
	Returns the bottom margin of the pane. More...
IlvPanedContainer *	getContainer () const
	Returns the paned container to which the pane belongs. More...
IlUShort	getLeftMargin () const
	Returns the left margin of the pane. More...
IlvPaneListener *const *	getListeners (IlUInt &count) const
	Returns an array of all the pane listeners. More...
IlvDim	getMinimumSize (IlvDirection direction) const
	Returns the minimum size of the pane. More...
const char *	getName () const
	Returns the name of the pane. More...
IlvNamedProperty *	getNamedProperty (const IlSymbol *name) const
	Returns the property whose name is specified. More...
IlAny	getProperty (const IlSymbol *key) const
	Returns the specified object property. More...
int	getResizeMode (IlvDirection direction) const
	Returns the resize mode of the pane for the specified direction. More...
IlUShort	getRightMargin () const
	Returns the right margin of the pane. More...
IlUShort	getTopMargin () const
	Returns the top margin of the pane. More...
IlBoolean	hasProperty (const IlSymbol *key) const
	Specifies whether the object has the specified property. More...
virtual void	hide ()
	Hides the pane. More...
IlBoolean	isVisible () const
	Specifies whether the pane is visible. More...
void	paneBBox (IlvRect &rect) const
	Returns the size and position of the pane, including margins. More...
void	removeListener (IlvPaneListener *listener)
	Disconnects a listener from the pane. More...
IlvNamedProperty *	removeNamedProperty (IlSymbol *name)
	Removes the specified named property from the object. More...
IlBoolean	removeProperty (const IlSymbol *key)
	Removes the specified object property. More...
void	setBottomMargin (IlUShort margin)
	Sets the bottom margin of the pane. More...
void	setLeftMargin (IlUShort margin)
	Sets the left margin of the pane. More...
void	setMargin (IlUShort margin)
	Sets all the margins of the pane. More...
void	setMinimumSize (IlvDirection dir, IlvDim size)
	Sets the minimum size of the pane. More...
void	setMinimumSize (IlvDim size)
	Sets the minimum sizes of the pane in all directions. More...
void	setName (const char *name)
	Sets the name of the pane. More...
IlvNamedProperty *	setNamedProperty (IlvNamedProperty *property)
	Sets the property whose name is specified. More...
void	setProperty (const IlSymbol *key, IlAny value)
	Sets the specified property to the object. More...
void	setResizeMode (IlvDirection direction, int mode)
	Sets the resize mode of the pane for the specified direction. More...
void	setResizeMode (int mode)
	Sets the resize mode of the pane both vertically and horizontally. More...
void	setRightMargin (IlUShort margin)
	Sets the right margin of the pane. More...
void	setTopMargin (IlUShort margin)
	Sets the top margin of the pane. More...
virtual void	show ()
	Shows the pane. More...

Additional Inherited Members
Public Types inherited from IlvPane
enum	ResizeMode { Fixed, Resizable, Elastic }
	This enumeration defines the possible values for a resize mode of an IlvPane object. More...

Detailed Description

Pane class.

Library: ilvadvgdt

An IlvGraphicPane object is a pane that encapsulates an IlvGraphic object.

See Also

IlvPanedContainer, IlvViewPane.

Constructor & Destructor Documentation

IlvGraphicPane::IlvGraphicPane	(	const char *	name,
		IlvGraphic *	graphic,
		IlUShort	margin = 2,
		IlBoolean	owner = IlTrue
	)

Constructor.

Initializes a new instance of the IlvGraphicPane class.

Parameters

name	The name of the pane.
graphic	The encapsulated graphic object.
margin	The margin value of the left, right, top and bottom borders.
owner	A Boolean value specifying whether the pane is the owner graphic. If owner is set to IlTrue or is omitted, deleting the graphic pane will cause the associated graphic to be deleted as well.

Member Function Documentation

virtual void IlvGraphicPane::boundingBox ( IlvRect &  rect ) const

virtual

Returns the size and position of the pane.

Puts in rect the size and position of the pane.

Parameters

rect	The returned size and position of the pane.

See Also

moveResize().

Implements IlvPane.

IlvGraphic* IlvGraphicPane::getObject

(

)

const

Returns the graphic object encapsulated by the pane.

Returns

The graphic object encapsulated by the pane.

See Also

setObject().

IlBoolean IlvGraphicPane::isDoubleBuffering

(

)

const

Tests the pane double buffering setting.

Returns

The pane double buffering setting

virtual void IlvGraphicPane::moveResize ( const IlvRect &  rect )

virtual

Moves and resizes the pane.

Parameters

rect	The new size and position of the pane.

See Also

boundingBox().

Reimplemented from IlvPane.

Reimplemented in IlvAbstractBarPane, and IlvDockingHandlePane.

virtual void IlvGraphicPane::setContainer ( IlvPanedContainer *  container )

virtual

Is called when the container of the pane changes.

Parameters

container

The new pane container.

See Also

IlvPanedContainer::addPane(), IlvPanedContainer::removePane().

Reimplemented from IlvPane.

Reimplemented in IlvAbstractBarPane.

virtual void IlvGraphicPane::setDoubleBuffering ( IlBoolean  value )

virtual

Sets double buffering.

Use this member function to indicate whether or not the IlvPanedContainer instance associated with the pane should use double buffering.

Parameters

value

A Boolean value indicating if the IlvPanedContainer instance associated with the pane should use double buffering (IlTrue) or not (IlFalse).

See Also

getTopView().

virtual void IlvGraphicPane::setFocus ( IlvEvent *  event = 0 )

virtual

Gives the focus to the pane.

Parameters

event

A pointer to the event that triggered the call to this method.

Implements IlvPane.

void IlvGraphicPane::setObject	(	IlvGraphic *	obj,
		IlBoolean	owner = IlTrue
	)

Sets the graphic object encapsulated by the pane.

Parameters

obj	The encapsulated graphic object.
owner	A Boolean value specifying whether the pane is the owner of obj. If owner is IlTrue, deleting the graphic pane will cause the associated graphic to be deleted as well.

See Also

getObject().