rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvDockingConfiguration Class Reference

Dockable utility class. More...

#include <ilviews/gadgets/dockutil.h>

List of all members.

Public Member Functions

 IlvDockingConfiguration ()
 Constructor.
void addLocation (const IlvDockingPaneLocation *loc)
 Adds the specified pane location to this configuration.
void clean ()
 Removes and deletes all the pane location of this configuration.
IlUInt getCardinal () const
 Returns the number of pane locations this configuration has.
const IlvDockingPaneLocationgetLocation (IlUInt index) const
 Returns the pane location whose index is specified.
const IlvDockingPaneLocationgetLocation (const char *name) const
 Returns the pane location whose name is specified.

Detailed Description

Dockable utility class.

Library: ilvadvgdt

The IlvDockingConfiguration class is a collection of IlvDockingPaneLocation objects. It is used by the IlvDockingConfigurationHandler class to switch from one docking configuration to another.

See also:
IlvDockableMainWindow, IlvDockingPaneLocation, IlvDockingConfigurationHandler

Constructor & Destructor Documentation

IlvDockingConfiguration::IlvDockingConfiguration (  ) 

Constructor.

Initializes a new instance of the IlvDockingConfiguration class.


Member Function Documentation

void IlvDockingConfiguration::addLocation ( const IlvDockingPaneLocation loc  ) 

Adds the specified pane location to this configuration.

Parameters:
loc The pane location.
See also:
clean
void IlvDockingConfiguration::clean (  ) 

Removes and deletes all the pane location of this configuration.

See also:
addLocation
IlUInt IlvDockingConfiguration::getCardinal (  )  const

Returns the number of pane locations this configuration has.

Returns:
The number of pane locations this configuration has.
const IlvDockingPaneLocation* IlvDockingConfiguration::getLocation ( IlUInt  index  )  const

Returns the pane location whose index is specified.

Parameters:
index The index of the pane location.
Returns:
The pane location of index index.
const IlvDockingPaneLocation* IlvDockingConfiguration::getLocation ( const char *  name  )  const

Returns the pane location whose name is specified.

Parameters:
name The name of the pane location.
Returns:
The pane location whose name is name. Returns 0 if no pane location has the name name in this configuration.

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