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
IlvDockableMainWindow Class Reference

Dockable container class. More...

#include <ilviews/gadgets/dockutil.h>

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

Public Member Functions

 IlvDockableMainWindow (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties=0, IlBoolean visible=IlTrue, IlvSystemView transientFor=0)
 Constructor. More...
 
 IlvDockableMainWindow (IlvAbstractView *parent, const IlvRect &rect, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvDockableMainWindow (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvDockableMainWindow (IlvDisplay *display, IlvSystemView window)
 Constructor. More...
 
IlvDockableaddRelativeDockingPane (IlvPane *pane, const char *relativePaneName, IlvPosition relativePanePosition)
 Adds the specified pane to the dockable container using a position relative to another pane. More...
 
IlvViewPanegetMainWorkspaceViewPane () const
 Returns the main workspace view pane. More...
 
- Public Member Functions inherited from 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. 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 IlvDockableMainWindow class is a subclass of IlvDockableContainer for managing the main window of a standard application that use docking panes. An IlvDockableMainWindow object is a vertical dockable container that defines a default layout that makes it possible to add docking panes by specifying a position relative to other docking panes. Using this class, you don't have to know the complete hierarchy of the dockable containers, which can be complex to understand and manage. Instead, you can think of your application main window as a simple list of docking panes.

- Layout of an IlvDockableMainWindow object -

See Also
IlvDockable, addRelativeDockingPane

Constructor & Destructor Documentation

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

Constructor.

Initializes a new instance of the IlvDockableMainWindow class.

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.
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.
IlvDockableMainWindow::IlvDockableMainWindow ( IlvAbstractView parent,
const IlvRect rect,
IlBoolean  visible = IlTrue 
)

Constructor.

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

Parameters
parentParent view of the dockable container.
rectSize and position of the dockable container.
visibleA Boolean value specifying whether the dockable container is visible.
IlvDockableMainWindow::IlvDockableMainWindow ( IlvDisplay display,
IlvSystemView  parent,
const IlvRect rect,
IlBoolean  visible = IlTrue 
)

Constructor.

Initializes a new instance of the IlvDockableMainWindow 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.
visibleA Boolean value specifying whether the dockable container is visible.
IlvDockableMainWindow::IlvDockableMainWindow ( IlvDisplay display,
IlvSystemView  window 
)

Constructor.

Initializes a new instance of the IlvDockableMainWindow 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.

Member Function Documentation

IlvDockable* IlvDockableMainWindow::addRelativeDockingPane ( IlvPane pane,
const char *  relativePaneName,
IlvPosition  relativePanePosition 
)

Adds the specified pane to the dockable container using a position relative to another pane.

This methods use relativePaneName and relativePanePosition to find the dockable container and the index in this container where pane must be added. Then it calls IlvDockableContainer::addDockingPane on this container.

Parameters
paneThe pane to be added.
relativePaneNameThe name of the pane to which pane will be relative.
relativePanePositionThe relative position of pane compared to the pane whose name is given by relativePaneName. Valid values are: IlvLeft, IlvRight, IlvBottom, IlvTop.
Returns
The instance of IlvDockable connected to pane.
See Also
getMainWorkspaceViewPane, getRelativePane
IlvViewPane* IlvDockableMainWindow::getMainWorkspaceViewPane ( ) const

Returns the main workspace view pane.

This view pane is created by the constructor of IlvDockableMainWindow and should never be removed nor deleted. On the other hand, you can change the view managed by this view pane using the IlvViewPane::setView method. The main feature of this view pane is that it's elastic (see IlvPane::getResizeMode).

Returns
The main workspace view pane.
See Also
IlvViewPane::setView, IlvPane::getResizeMode, addRelativeDockingPane

© 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.