rwlogo

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Classes | Enumerations | Functions
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. More...
 
void IlvGetAttachmentDistance (const IlvGraphic *graphic, IlvPosition position)
 Returns the distance set on the attachment rule of the specified border of the object. More...
 
void IlvRemoveAttachment (IlvGraphic *graphic, IlvPosition position)
 Removes the attachment set on the specified border of the object. More...
 
void IlvSetAttachment (IlvGraphic *graphic, IlvPosition position, IlvGraphicAttachment attachment, IlvDim distance=0)
 Sets the attachment rule for the specified object. More...
 

Detailed Description

Library: views Declaration of the classes and methods used to handle graphic attachments.

Enumeration Type Documentation

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
graphicThe graphic object.
positionA 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
graphicThe graphic object.
positionA 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
graphicThe graphic object to detach.
positionA 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
graphicThe graphic object to attach.
positionA 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.
attachmentThe type of attachment.
distanceThe distance used for fixed attachemnts.
See Also
IlvRemoveAttachment, IlvGetAttachment, IlvGetAttachmentDistance.

© Copyright 2015, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.