Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Holder class. More...
#include <ilviews/graphics/holder.h>
Inherited by IlvContainerGraphicHolder, and IlvSubGraphicHolder.
Public Member Functions | |
virtual IlUInt | addGuide (IlvDirection dir, IlvPos pos, IlInt weight=0, IlInt limit=1) |
Adds a new guide to this holder. More... | |
virtual IlBoolean | allowFocus (IlBoolean flag)=0 |
Specifies whether to enable or disable keyboard focus navigation in the holder. More... | |
virtual void | applyToObject (IlvGraphic *obj, IlvApplyObject f, IlAny arg, IlBoolean redraw=IlTrue)=0 |
Applies the specified function to the specified graphic object. More... | |
virtual void | applyToObjects (IlvApplyObject f, IlAny arg, IlBoolean redraw=IlTrue) |
Applies the specified function to all the objects of the holder. More... | |
void | attach (IlvGraphic *obj, IlvDirection dir, IlInt weightBefore=0, IlInt objectWeight=1, IlInt weightAfter=0, IlUInt guide1ndx=0, IlUInt guide2ndx=(IlUInt)-1) |
Attaches an object to the holder. More... | |
virtual IlvBitmap * | getBitmap () const =0 |
Returns the bitmap of this holder. More... | |
virtual IlvContainer * | getContainer () const |
Returns the container connected to this holder. More... | |
virtual IlvDisplay * | getDisplay () const =0 |
Returns the display of the holder. More... | |
virtual IlvGraphic * | getFocus () const =0 |
Returns the graphic object having the keyboard focus in this holder. More... | |
IlUInt | getGuideCardinal (IlvDirection dir) const |
Returns the number of guides in the specified direction. More... | |
IlInt | getGuideLimit (IlvDirection dir, IlUInt index) const |
Returns the minimum size of a guide in the specified direction. More... | |
IlvPos | getGuidePosition (IlvDirection dir, IlUInt index) const |
Returns the position of a guide in the specified direction. More... | |
IlInt | getGuideSize (IlvDirection dir, IlUInt index) const |
Returns the size of a guide in the specified direction. More... | |
IlInt | getGuideWeight (IlvDirection dir, IlUInt index) const |
Returns the weight of a guide in the specified direction. More... | |
virtual IlvLookFeelHandler * | getLookFeelHandler () const |
Returns the look and feel handler of the holder. More... | |
virtual IlvManager * | getManager () const |
Returns the manager connected to this holder. More... | |
IlvGraphicHolder * | getNextFocusHolder () const |
Returns the next holder in the focus chain. More... | |
virtual IlvGraphic *const * | getObjects (IlUInt &count) const =0 |
Returns an array containing all the objects of this holder. More... | |
IlvGraphicHolder * | getPreviousFocusHolder () const |
Returns the previous holder in the focus chain. More... | |
virtual IlvTransformer * | getTransformer () const =0 |
Returns the transformer of this holder. More... | |
virtual IlvView * | getView () const =0 |
Returns the view of this holder. More... | |
virtual IlBoolean | isAContainer () const =0 |
Indicates whether or not this holder is connected to a container. More... | |
virtual IlBoolean | isFocusAllowed () const =0 |
Returns IlTrue if the keyboard focus navigation is enabled in this holder. More... | |
virtual IlBoolean | isVisible (const IlvGraphic *obj) const =0 |
Indicates if the specified graphic object is set to be visible. More... | |
virtual void | moveFocusAfter (IlBoolean redraw=IlTrue)=0 |
Moves the keyboard focus to the next object. More... | |
virtual void | moveFocusBefore (IlBoolean redraw=IlTrue)=0 |
Moves the keyboard focus to the previous object. More... | |
virtual void | moveFocusFirst ()=0 |
Moves the focus to the first object of the holder. | |
virtual void | moveFocusLast ()=0 |
Moves the focus to the last object of the holder. | |
void | removeAttachments (IlvGraphic *obj, IlvDirection dir) |
Removes the attachments of an object. More... | |
virtual void | removeGrab ()=0 |
Removes the grab of an object in this holder. | |
virtual IlBoolean | removeGuide (IlvDirection dir, IlUInt index) |
Removes the specified guide from this holder. More... | |
virtual void | setFocus (IlvGraphic *obj=0, IlBoolean redraw=IlTrue) const =0 |
Gives the keyboard focus to the specified object. More... | |
virtual void | setGrab (IlvGraphic *obj)=0 |
Sets the grab of this holder to obj. More... | |
virtual void | setLookFeelHandler (IlvLookFeelHandler *lfh) |
Sets the look and feel handler of the holder. More... | |
void | setNextFocusHolder (IlvGraphicHolder *holder) |
Sets the next holder in the focus chain. More... | |
void | setPreviousFocusHolder (IlvGraphicHolder *holder) |
Sets the previous holder in the focus chain. More... | |
virtual void | setVisible (IlvGraphic *obj, IlBoolean visible, IlBoolean redraw)=0 |
Sets the visibility of the specified graphic object. More... | |
Holder class.
Library: views
The class IlvGraphicHolder
is an abstraction to unify the API of IlvContainer
and IlvManager
. It allows the user to perform many operations without knowing if they occur on a container or a manager.
Every container and manager has a pointer to an IlvGraphicHolder
instance, and every graphic object of this container or manager has a pointer to the same IlvGraphicHolder
instance. A graphic object retrieves its holder by using the method IlvGraphic::getHolder()
.
IlvContainer
, IlvManager
, IlvGadgetContainer
, IlvGadgetManager
.
|
virtual |
Adds a new guide to this holder.
Adds a new guide in the direction specified by dir.
dir | The direction of the new guide. Valid directions are IlvHorizontal and IlvVertical . |
pos | The initial position of the guide. |
weight | The weight of the new guide. |
limit | The minimum size of the new guide. |
-1
if the guide has not been added. IlvSplitterGadget
Specifies whether to enable or disable keyboard focus navigation in the holder.
flag | A Boolean value specifying whether the keyboard focus is enabled or disabled. |
|
pure virtual |
Applies the specified function to the specified graphic object.
obj | The graphic object. |
f | The function to apply. |
arg | The argument that will be passed to f. |
redraw | A Boolean value specifying whether to redraw the holder or not. |
|
virtual |
Applies the specified function to all the objects of the holder.
f | The function to apply. |
arg | The argument that will be passed to f. |
redraw | A Boolean value specifying whether to redraw the holder or not. |
void IlvGraphicHolder::attach | ( | IlvGraphic * | obj, |
IlvDirection | dir, | ||
IlInt | weightBefore = 0 , |
||
IlInt | objectWeight = 1 , |
||
IlInt | weightAfter = 0 , |
||
IlUInt | guide1ndx = 0 , |
||
IlUInt | guide2ndx = (IlUInt)-1 |
||
) |
Attaches an object to the holder.
Sets attachments on the IlvGraphic
object obj, in the direction dir. For details about attachments and guide, see the User's manual.
obj | The graphic object to attach. |
dir | The direction in which in the object is to be attached. Valid values are IlvHorizontal and IlvVertical . |
weightBefore | The weight of the section between the graphic object and the closest guide to the left (or above if dir is IlvVertical ). |
objectWeight | The weight of the bounding box of the object itself. |
weightAfter | The weight of the section between the graphic object and the closest guide to the right (or below if dir is IlvVertical ). |
guide1ndx | The left (or top) section to which the object will be attached. |
guide2ndx | The right (or bottom) section to which the object will be attached. |
|
pure virtual |
Returns the bitmap of this holder.
This bitmap is used for double buffering. If double buffering has not been enabled for this holder, this method returns 0
.
|
virtual |
Returns the container connected to this holder.
0
if the holder is not an IlvContainerGraphicHolder
.
|
pure virtual |
Returns the display of the holder.
|
pure virtual |
Returns the graphic object having the keyboard focus in this holder.
IlUInt IlvGraphicHolder::getGuideCardinal | ( | IlvDirection | dir | ) | const |
Returns the number of guides in the specified direction.
dir | The direction. Valid directions are IlvHorizontal and IlvVertical . |
IlInt IlvGraphicHolder::getGuideLimit | ( | IlvDirection | dir, |
IlUInt | index | ||
) | const |
Returns the minimum size of a guide in the specified direction.
dir | The direction. Valid directions are IlvHorizontal and IlvVertical . |
index | The index of the guide. |
IlvPos IlvGraphicHolder::getGuidePosition | ( | IlvDirection | dir, |
IlUInt | index | ||
) | const |
Returns the position of a guide in the specified direction.
dir | The direction. Valid directions are IlvHorizontal and IlvVertical . |
index | The index of the guide. |
IlInt IlvGraphicHolder::getGuideSize | ( | IlvDirection | dir, |
IlUInt | index | ||
) | const |
Returns the size of a guide in the specified direction.
dir | The direction. Valid directions are IlvHorizontal and IlvVertical . |
index | The index of the guide. |
IlInt IlvGraphicHolder::getGuideWeight | ( | IlvDirection | dir, |
IlUInt | index | ||
) | const |
Returns the weight of a guide in the specified direction.
dir | The direction. Valid directions are IlvHorizontal and IlvVertical . |
index | The index of the guide. |
|
virtual |
Returns the look and feel handler of the holder.
|
virtual |
Returns the manager connected to this holder.
0
if the holder is not an IlvManagerGraphicHolder
. IlvGraphicHolder* IlvGraphicHolder::getNextFocusHolder | ( | ) | const |
Returns the next holder in the focus chain.
The returned holder will be the next holder to obtain the keyboard focus when the Tab key is pressed in the last gadget of the focus chain.
|
pure virtual |
Returns an array containing all the objects of this holder.
count | The size of the returned array. |
IlvGraphicHolder* IlvGraphicHolder::getPreviousFocusHolder | ( | ) | const |
Returns the previous holder in the focus chain.
The returned holder will be the next holder to obtain the keyboard focus when the Shift-Tab key is pressed in the first gadget of the focus chain.
|
pure virtual |
Returns the transformer of this holder.
|
pure virtual |
Returns the view of this holder.
|
pure virtual |
Indicates whether or not this holder is connected to a container.
IlTrue
if the holder is an IlvContainerGraphicHolder
or IlFalse
otherwise.
|
pure virtual |
Returns IlTrue
if the keyboard focus navigation is enabled in this holder.
IlTrue
if the keyboard focus navigation is enabled in this holder.
|
pure virtual |
Indicates if the specified graphic object is set to be visible.
Here, 'visible' does not necessarily mean that the object can be seen; it may be hidden by overlapping objects, or located beyond the visible boundaries of the holder, or the holder itself may be hidden.
obj | The graphic object. |
IlTrue
if the object is visible, IlFalse
otherwise. Moves the keyboard focus to the next object.
redraw | A Boolean value specifying whether to redraw the holder or not. |
Moves the keyboard focus to the previous object.
redraw | A Boolean value specifying whether to redraw the holder or not. |
void IlvGraphicHolder::removeAttachments | ( | IlvGraphic * | obj, |
IlvDirection | dir | ||
) |
Removes the attachments of an object.
Removes the attachments previously set on the IlvGraphic
object obj, along the direction dir.
obj | The graphic object to detach. |
dir | The direction in which in the object is to be detached. Valid values are IlvHorizontal and IlvVertical . |
|
virtual |
Removes the specified guide from this holder.
dir | The direction of the guide to remove. Valid directions are IlvHorizontal and IlvVertical . |
index | The index of the guide to remove. |
|
pure virtual |
Gives the keyboard focus to the specified object.
obj | The new focused object. |
redraw | A Boolean value specifying whether to redraw the holder or not. |
|
pure virtual |
Sets the grab of this holder to obj.
After calling this method, all the events sents to this holder will be dispatched to obj.
obj | The graphic object that will grab all the events. |
|
virtual |
Sets the look and feel handler of the holder.
lfh | The new look and feel handler for this holder. |
void IlvGraphicHolder::setNextFocusHolder | ( | IlvGraphicHolder * | holder | ) |
Sets the next holder in the focus chain.
holder will be the next holder to obtain the keyboard focus when the Tab key is pressed in the last gadget of the focus chain.
holder | The next holder in the focus chain. |
void IlvGraphicHolder::setPreviousFocusHolder | ( | IlvGraphicHolder * | holder | ) |
Sets the previous holder in the focus chain.
holder will be the next holder to obtain the keyboard focus when the Tab key is pressed in the first gadget of the focus chain.
holder | The next holder in the focus chain. |
|
pure virtual |
Sets the visibility of the specified graphic object.
obj | The graphic object. |
visible | If IlTrue , the object is set to be visible. If IlFalse , it is set to be invisible and the holder will not draw it. |
redraw | If IlTrue , the holder will redraw the object bounding box after changing its visibility. |
© Copyright 2016, 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.