rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvDockableContainer Class Reference

Dockable container class. More...

#include <ilviews/gadgets/dockpane.h>

Inheritance diagram for IlvDockableContainer:
IlvPanedContainer IlvGadgetContainer IlvContainer IlvDrawingView IlvView IlvAbstractView IlvSystemPort IlvPort IlvDockableMainWindow

Public Member Functions

 IlvDockableContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlvDirection direction, IlUInt properties=0, IlBoolean visible=IlTrue, IlvSystemView transientFor=0)
 Constructor. More...
 
 IlvDockableContainer (IlvAbstractView *parent, const IlvRect &rect, IlvDirection direction, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvDockableContainer (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlvDirection direction, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvDockableContainer (IlvDisplay *display, IlvSystemView window, IlvDirection direction)
 Constructor. More...
 
virtual IlBoolean acceptDocking (const IlvPane *pane, IlUInt index) const
 Indicates whether the dockable container allows that the specified pane be docked. More...
 
IlvDockableaddDockingPane (IlvPane *pane, IlUInt index=(IlUInt)-1)
 Adds a docking pane to the dockable container. More...
 
virtual IlvDockablecreateDockable (IlvPane *pane) const
 Returns a new instance of the IlvDockable class. More...
 
IlBoolean createOrthogonalDockableContainer () const
 Indicates whether an orthogonal dockable container is created before a pane is docked. More...
 
void createOrthogonalDockableContainer (IlBoolean enable)
 Specifies whether an orthogonal dockable container should be created before docking a pane. More...
 
IlvPane *const * getAllDockingPanes (IlUInt &count, IlBoolean visible=IlTrue, int mode=-1) const
 Returns an array of the panes docked to the dockable container. More...
 
IlvPane *const * getDockingPanes (IlUInt &count, IlBoolean visible=IlTrue, int mode=-1) const
 Returns an array of the panes docked to the dockable container. More...
 
IlBoolean isDockable () const
 Indicates whether the dockable container allows docking. More...
 
virtual void removePane (IlUInt rank, IlBoolean destroy=IlFalse)
 Removes the pane whose index is specified from the paned container. More...
 
void setDockable (IlBoolean enable)
 Specifies whether the dockable container should allow docking. More...
 
- Public Member Functions inherited from IlvPanedContainer
 IlvPanedContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlvDirection direction, IlUInt properties=0, IlBoolean visible=IlTrue, IlvSystemView transientFor=0)
 Constructor. More...
 
 IlvPanedContainer (IlvAbstractView *parent, const IlvRect &rect, IlvDirection direction, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvPanedContainer (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlvDirection direction, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvPanedContainer (IlvDisplay *display, IlvSystemView window, IlvDirection direction)
 Constructor. More...
 
virtual void addPane (IlvPane *pane, IlUInt index=(IlUInt)-1)
 Adds a pane to the paned container at the specified index. More...
 
IlAny applyUntil (IlvApplyPane func, IlAny arg=0)
 Applies the specified function to all the panes of the paned container. More...
 
IlUInt getCardinal () const
 Returns the number of panes managed by the paned container. More...
 
IlvDirection getDirection () const
 Returns the direction of the paned container. More...
 
IlUInt getIndex (const IlvPane *pane) const
 Returns the index of the specified pane. More...
 
IlvPanegetPane (const char *name, IlBoolean all=IlFalse) const
 Searches the pane whose name is specified. More...
 
IlvPanegetPane (IlUInt index) const
 Returns the pane whose index is specified. More...
 
IlvViewPanegetViewPane () const
 Returns the view pane that encapsulates the paned container. More...
 
IlBoolean isManagingSliders () const
 Returns IlTrue if the paned container manages automatic sliders. More...
 
void manageSliders (IlBoolean value)
 Specifies whether the paned container manages sliders automatically. More...
 
void paneBBox (const IlvPane *pane, IlvRect &bbox) const
 Returns the bounding box of the specified pane. More...
 
virtual void paneGeometryChanged (IlvPane *pane)
 Is called when the geometry of the specified pane changes. More...
 
virtual void paneVisibilityChanged (IlvPane *pane)
 Is called when the specified pane is hidden or shown. More...
 
IlUInt pointToPane (const IlvPoint &point) const
 Returns the index of the pane located at the position specified by point. More...
 
void setDirection (IlvDirection direction)
 Sets the direction of the paned container. More...
 
virtual void updatePanes (IlBoolean all=IlFalse)
 Updates the position and size of all the panes. More...
 
- Public Member Functions inherited from IlvGadgetContainer
 IlvGadgetContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvGadgetContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue, IlvSystemView transientFor=0)
 Constructor. More...
 
 IlvGadgetContainer (IlvAbstractView *parent, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvGadgetContainer (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvGadgetContainer (IlvDisplay *display, IlvSystemView window, IlBoolean useacc=IlFalse)
 Constructor. More...
 
virtual IlBoolean allowFocus (IlBoolean value)
 Specifies whether the container manages the focus. More...
 
virtual void applyResize (IlFloat sx, IlFloat sy, IlBoolean redraw=IlTrue)
 Is called to carry out the resize events applying to the gadget container. More...
 
IlBoolean autoResize (IlBoolean a)
 Sets the auto resize mode of the gadget container. More...
 
IlvButtongetDefaultButton () const
 Returns the default button of the gadget container. More...
 
virtual IlvGraphicgetFirstFocusGraphic () const
 Returns the first object that receives the focus in this container. More...
 
virtual IlvGraphicgetFocus () const
 Returns the object that has the keyboard focus in the gadget container. More...
 
virtual IlvGraphicgetGrab () const
 Returns the object that is currently grabbing events in the container. More...
 
virtual IlvGraphicgetLastFocusGraphic () const
 Returns the last object that receives the focus in this container. More...
 
IlvLookFeelHandlergetLookFeelHandler () const
 Returns the look and feel handler associated with this container. More...
 
virtual IlvGraphicgetNextFocusGraphic (IlvGraphic *object) const
 Returns the next object that will receive the focus after the specified object. More...
 
IlvGraphicgetOverriddenFocus () const
 Returns the object that will receive the focus after calling setFocus. More...
 
virtual IlvGraphicgetPreviousFocusGraphic (IlvGraphic *object) const
 Returns the previous object that received the focus before the specified object. More...
 
IlBoolean isAutoResizing () const
 Indicates whether the gadget container gets resized when loading a file. More...
 
virtual IlBoolean isFocusAllowed () const
 Indicates whether the focus is allowed in the container. More...
 
virtual void moveFocusAfter (IlBoolean redraw=IlTrue)
 Is called to find the next focusable object. More...
 
virtual void moveFocusBefore (IlBoolean redraw=IlTrue)
 Is called to find the previous focusable object. More...
 
void overrideFocus (IlvGraphic *obj)
 Sets the object that will receive the focus after calling setFocus. More...
 
virtual void removeGrab ()
 Cancels the grabbing settings defined with setGrab. More...
 
void setDefaultButton (IlvButton *, IlBoolean redraw=IlTrue)
 Sets the default button of the gadget container. More...
 
virtual void setFocus (IlvGraphic *graphic=0, IlBoolean redraw=IlTrue)
 Sets the focus to the specified object of the gadget container. More...
 
virtual void setGrab (IlvGraphic *object)
 Sets the specified object as the grabbing object. More...
 
void setLookFeelHandler (IlvLookFeelHandler *lfh)
 Sets the look and feel handler of this container. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IlvPanedContainer
virtual IlvSliderPanecreateSliderPane (const char *) const
 Creates and returns a new slider pane. More...
 

Detailed Description

Dockable container class.

Library: ilvadvgdt

The IlvDockableContainer class is a subclass of IlvPanedContainer for managing docking panes. A docking pane is a pane that can be moved to any dockable area in an interactive way.

See Also
IlvDockable, IlvPane.

Constructor & Destructor Documentation

IlvDockableContainer::IlvDockableContainer ( IlvDisplay display,
const char *  name,
const char *  title,
const IlvRect rect,
IlvDirection  direction,
IlUInt  properties = 0,
IlBoolean  visible = IlTrue,
IlvSystemView  transientFor = 0 
)

Constructor.

Initializes a new instance of the IlvDockableContainer class as a top view.

Parameters
displayThe connection to the display.
nameThe name of the dockable container.
titleThe title of the dockable container.
rectThe size and position of the dockable container.
directionThe direction of the dockable container. For details, see the IlvPanedContainer constructors.
propertiesThe properties of the dockable container. For details, see the IlvView constructors.
visibleA Boolean value specifying whether the dockable container is visible.
transientForThe system view for which the dockable container is transient. For more details, see the IlvView constructors.
IlvDockableContainer::IlvDockableContainer ( IlvAbstractView parent,
const IlvRect rect,
IlvDirection  direction,
IlBoolean  visible = IlTrue 
)

Constructor.

Initializes a new instance of the IlvDockableContainer class as a child view of parent.

Parameters
parentParent view of the dockable container.
rectSize and position of the dockable container.
directionThe direction of the dockable container. For details, see the IlvPanedContainer constructors.
visibleA Boolean value specifying whether the dockable container is visible.
IlvDockableContainer::IlvDockableContainer ( IlvDisplay display,
IlvSystemView  parent,
const IlvRect rect,
IlvDirection  direction,
IlBoolean  visible = IlTrue 
)

Constructor.

Initializes a new instance of the IlvDockableContainer class as a child view of the system view specified by parent.

Parameters
displayConnection to the display.
parentParent view of the dockable container.
rectSize and position of the dockable container.
directionDirection of the dockable container. For more details, see the IlvPanedContainer constructors.
visibleA Boolean value specifying whether the dockable container is visible.
IlvDockableContainer::IlvDockableContainer ( IlvDisplay display,
IlvSystemView  window,
IlvDirection  direction 
)

Constructor.

Initializes a new instance of the IlvDockableContainer class mapped to the existing system view specified by parent.

Parameters
displayConnection to the display.
windowSystem view to which the dockable container will be mapped.
directionDirection of the dockable container. For more details, see the IlvPanedContainer constructors.

Member Function Documentation

virtual IlBoolean IlvDockableContainer::acceptDocking ( const IlvPane pane,
IlUInt  index 
) const
virtual

Indicates whether the dockable container allows that the specified pane be docked.

The default implementation simply calls the IlvDockableContainer::isDockable method. If you want to filter the docking of panes, you can override this method in subclasses of IlvDockableContainer.

Parameters
paneThe pane to be docked.
indexThe position where pane will be docked.
Returns
A Boolean value specifying whether docking is allowed for pane at index.
See Also
isDockable.
IlvDockable* IlvDockableContainer::addDockingPane ( IlvPane pane,
IlUInt  index = (IlUInt)-1 
)

Adds a docking pane to the dockable container.

Inserts the specified pane at the index +1 position. A handle pane will be inserted at the position specified by index to allow interactive docking. When the method IlvDockableContainer::createOrthogonalDockableContainer returns IlTrue, the pane is not directly inserted into the dockable container but is added to a new dockable container, which is orthogonal to the one where the pane was initially to be docked. The new container is then encapsulated in a view pane using the IlvViewPane class, and the view pane is added to the dockable container at the specified index.
If no instance of the IlvDockable class was connected to pane, a new instance of IlvDockable is created and automatically connected to pane.

Parameters
paneThe pane to be docked.
indexThe position where pane will be docked.
Returns
The instance of the IlvDockable class connected to pane.
See Also
IlvDockable
virtual IlvDockable* IlvDockableContainer::createDockable ( IlvPane pane) const
virtual

Returns a new instance of the IlvDockable class.

This method is called by the addDockingPane method when the added pane is not already connected to an instance of the IlvDockable class. You may override this method if you want to create your own subclass of the IlvDockable class.

Parameters
paneThe pane for which the instance of the IlvDockable class is asked.
Returns
A new instance of the IlvDockable class connected to pane.
See Also
addDockingPane
IlBoolean IlvDockableContainer::createOrthogonalDockableContainer ( ) const

Indicates whether an orthogonal dockable container is created before a pane is docked.

Returns
IlTrue if the dockable container automatically creates an orthogonal dockable container before docking a pane.
See Also
addDockingPane
void IlvDockableContainer::createOrthogonalDockableContainer ( IlBoolean  enable)

Specifies whether an orthogonal dockable container should be created before docking a pane.

For details, see the method IlvDockableContainer::addDockingPane.

Parameters
enableA Boolean value specifying whether an orthogonal dockable container should be created before docking a pane (IlTrue) or not (IlFalse).
See Also
addDockingPane
IlvPane* const* IlvDockableContainer::getAllDockingPanes ( IlUInt count,
IlBoolean  visible = IlTrue,
int  mode = -1 
) const

Returns an array of the panes docked to the dockable container.

This method is the same as getDockingPanes, except that it is recursive.

Parameters
countThe number of docking panes in the returned array.
visibleA Boolean value specifying whether only the visible docking panes (IlTrue), or all the docking panes (IlFalse) should be retrieved.
modeAn integer that specify the resize mode that docking must match. If mode is -1, or is omitted, then no resize mode is used when finding docking panes. Valid values for this parameter are: -1, IlvPane::Resizable, IlvPane::Elastic, or IlvPane::Fixed.
Returns
An array of the docking panes of the dockable container. The returned array should never be modified nor deleted.
See Also
getDockingPanes
IlvPane* const* IlvDockableContainer::getDockingPanes ( IlUInt count,
IlBoolean  visible = IlTrue,
int  mode = -1 
) const

Returns an array of the panes docked to the dockable container.

This method returns an array that contains the docking panes that match the specified parameters visible and mode. A docking pane is a pane that has an IlvDockable instance connected to it. This method is not recursive. Use the member function getAllDockingPanes to obtain all the docking panes of a dockable container.

Parameters
countThe number of docking panes in the returned array.
visibleA Boolean value specifying whether only the visible docking panes (IlTrue) or all the docking panes (IlFalse) should be retrieved.
modeAn integer that specify the resize mode that docking must match. If the mode is -1, or is omitted, then no resize mode is used when finding docking panes. Valid values for this parameter are: -1, IlvPane::Resizable, IlvPane::Elastic, or IlvPane::Fixed.
Returns
An array of the docking panes of the dockable container. The returned array should never be modified nor deleted.
See Also
addDockingPane
IlBoolean IlvDockableContainer::isDockable ( ) const

Indicates whether the dockable container allows docking.

Returns
IlTrue if the dockable container allows the docking of panes.
See Also
setDockable, acceptDocking
virtual void IlvDockableContainer::removePane ( IlUInt  index,
IlBoolean  destroy = IlFalse 
)
virtual

Removes the pane whose index is specified from the paned container.

Parameters
indexThe index of the pane to be removed.
destroyA Boolean value specifying whether the removed pane should be destroyed.
See Also
addPane, getPane

Reimplemented from IlvPanedContainer.

void IlvDockableContainer::setDockable ( IlBoolean  enable)

Specifies whether the dockable container should allow docking.

Specifies whether the docking of panes is allowed (IlTrue) or not (IlFalse). If docking is not allowed for a dockable container, it will not be possible to dock a pane to it.

Parameters
enableA Boolean value specifying whether this dockable container allows docking.
See Also
isDockable, acceptDocking

© Copyright 2012, 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.