attach.h File Reference

#include <ilviews/base/graphic.h>
#include <ilviews/base/view.h>

Classes
class	IlvAttachmentsHandler
	Class used to handle attachments of graphic objects. More...
Enumerations
enum	IlvGraphicAttachment { IlvNoAttach, IlvFixedAttach, IlvElasticAttach, IlvFixAndElasticAttach }
	This enum type defines how graphic objects are attached to the borders of their container view, and whether the objects can be resized. The attachments thus establish the behavior of the objects when the size of the container view is changed. More...
Functions
void	IlvGetAttachment (const IlvGraphic *graphic, IlvPosition position)
	Returns the attachment rule set on the specified border of the object.
void	IlvGetAttachmentDistance (const IlvGraphic *graphic, IlvPosition position)
	Returns the distance set on the attachment rule of the specified border of the object.
void	IlvRemoveAttachment (IlvGraphic *graphic, IlvPosition position)
	Removes the attachment set on the specified border of the object.
void	IlvSetAttachment (IlvGraphic *graphic, IlvPosition position, IlvGraphicAttachment attachment, IlvDim distance=0)
	Sets the attachment rule for the specified object.

---

Detailed Description

[library views ilviews/graphics/attach.h] Declaration of the classes and methods used to handle graphic attachments.

---

Enumeration Type Documentation

enum IlvGraphicAttachment

This enum type defines how graphic objects are attached to the borders of their container view, and whether the objects can be resized. The attachments thus establish the behavior of the objects when the size of the container view is changed.

Enumerator:

IlvNoAttach	Indicates that the attachment does not affect the object's size and location.
IlvFixedAttach	Indicates that the specified border or dimension remains fixed to some value no matter what size the view takes.
IlvElasticAttach	Indicates that the specified border or dimension moves proportionally as the view changes its size.
IlvFixAndElasticAttach	Indicates that the specified border or dimension moves proportionally as the view changes its size, with an additional offset specified.

---

Function Documentation

void IlvGetAttachment	(	const IlvGraphic *	graphic,
		IlvPosition	position
	)

Returns the attachment rule set on the specified border of the object.

Parameters:

	graphic	The graphic object.
	position	A position specifying for which border of the object bounding box the attachment is required. See IlvSetAttachment for details.

See also:

IlvSetAttachment, IlvGetAttachmentDistance.

void IlvGetAttachmentDistance	(	const IlvGraphic *	graphic,
		IlvPosition	position
	)

Returns the distance set on the attachment rule of the specified border of the object.

Parameters:

	graphic	The graphic object.
	position	A position specifying for which border of the object bounding box the attachment is required. See IlvSetAttachment for details.

See also:

IlvSetAttachment, IlvGetAttachment.

void IlvRemoveAttachment	(	IlvGraphic *	graphic,
		IlvPosition	position
	)

Removes the attachment set on the specified border of the object.

Parameters:

	graphic	The graphic object to detach.
	position	A position specifying which border of the object bounding box to detach. See IlvSetAttachment for details.

See also:

IlvSetAttachment.

void IlvSetAttachment	(	IlvGraphic *	graphic,
		IlvPosition	position,
		IlvGraphicAttachment	attachment,
		IlvDim	distance = 0
	)

Sets the attachment rule for the specified object.

Attaches the border of the bounding box specified by position of graphic using the parameters attachment and distance.

Parameters:

	graphic	The graphic object to attach.
	position	A position specifying which border of the object bounding box to attach. Valid values are: IlvLeft, IlvTop, IlvRight or IlvBottom to indicate which border of the object needs to be attached to the view, or IlvVertical and IlvHorizontal to indicate the behavior of the object's bounding box.
	attachment	The type of attachment.
	distance	The distance used for fixed attachemnts.

See also:

IlvRemoveAttachment, IlvGetAttachment, IlvGetAttachmentDistance.