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 | Static Public Member Functions | Friends
IlvDesktopManager Class Reference

Desktop class. More...

#include <ilviews/gadgets/desktop.h>

Public Member Functions

 IlvDesktopManager (IlvView *view)
 Constructor. More...
 
virtual void addFrame (IlvViewFrame *frame)
 Adds a frame to the desktop manager. More...
 
void cascadeFrames ()
 Cascades the frames. More...
 
virtual void frameMaximized (IlvViewFrame *frame, int previousState)
 Is called by the desktop when a frame is maximized. More...
 
virtual void frameMinimized (IlvViewFrame *frame, int previousState)
 Is called by the desktop when a frame is minimized. More...
 
virtual void frameRestored (IlvViewFrame *frame, int previousState)
 Is called by the desktop when a frame is restored. More...
 
virtual void frameSelectionChanged (IlvViewFrame *newFrame, IlvViewFrame *oldFrame)
 Is called when the current frame changes. More...
 
virtual IlvPalettegetActiveTitleBarPalette () const
 Returns the palette used to draw the title bar of active frames. More...
 
IlUInt getCardinal () const
 Returns the number of frames managed by the desktop. More...
 
IlvViewFramegetCurrentFrame () const
 Returns the current frame. More...
 
IlvViewFramegetFrame (IlUInt index) const
 Returns a pointer to a frame of the desktop. More...
 
IlvViewFrame *const * getFrames (IlUInt &count) const
 Returns an array of the frames managed by the desktop. More...
 
virtual IlvPalettegetInactiveTitleBarPalette () const
 Verbose: More...
 
IlvViewFrame *const * getMinimizedFrames (IlUInt &count) const
 Returns an array of the minimized frames of the desktop. More...
 
IlvViewFramegetNextFrame () const
 Returns the next frame, relative to the current frame. More...
 
IlvViewFramegetPreviousFrame () const
 Returns the previous frame, relative to the current frame. More...
 
IlvViewgetView () const
 Returns the desktop view of the desktop manager. More...
 
IlBoolean isMaximizing () const
 Indicates whether the desktop is maximized. More...
 
virtual void makeMaximizedStateButtons (IlvGraphicHolder *holder, IlvPos vOffset=-1, IlvPos hOffset=-1)
 Tells the desktop manager to place the frame buttons in a graphic holder when it is maximized. More...
 
virtual void makeMaximizedStateButtons (IlvToolBar *toolbar)
 Tells the desktop manager to place the frame buttons in a tool bar when it is maximized. More...
 
virtual void removeFrame (IlvViewFrame *frame)
 Removes a frame from the desktop manager. More...
 
virtual void setCurrentFrame (IlvViewFrame *frame, IlBoolean raise=IlTrue)
 Changes the current frame. More...
 
void tileFrames (IlvDirection direction)
 Tiles the frames. More...
 

Static Public Member Functions

static IlvDesktopManagerGet (IlvView *view)
 Returns the desktop manager linked to the specified view. More...
 

Friends

class IlvViewFrame
 

Detailed Description

Desktop class.

Library: ilvadvgdt

This class defines a desktop that contains IlvViewFrame objects. An IlvDesktopManager object is associated with a view that will be the parent view of all the frames managed by the desktop.

See Also
IlvViewFrame.

Constructor & Destructor Documentation

IlvDesktopManager::IlvDesktopManager ( IlvView view)

Constructor.

Initializes a new instance of the IlvDesktopManager class with view as the desktop view.

Parameters
viewThe desktop view.

Member Function Documentation

virtual void IlvDesktopManager::addFrame ( IlvViewFrame frame)
virtual

Adds a frame to the desktop manager.

Usually, you do not have to call this method, as it is automatically called by the constructor of the IlvViewFrame class. However, you may need to use it in specific cases.

Parameters
frameThe view frame.
See Also
removeFrame
void IlvDesktopManager::cascadeFrames ( )

Cascades the frames.

See Also
tileFrames
virtual void IlvDesktopManager::frameMaximized ( IlvViewFrame frame,
int  previousState 
)
virtual

Is called by the desktop when a frame is maximized.

The default implementation does nothing.

Parameters
frameThe maximized frame.
previousStateThe state of the frame before it was maximized.
See Also
IlvViewFrame::maximize, IlvViewFrame::getCurrentState
virtual void IlvDesktopManager::frameMinimized ( IlvViewFrame frame,
int  previousState 
)
virtual

Is called by the desktop when a frame is minimized.

The default implementation does nothing.

Parameters
frameThe minimized frame.
previousStateThe state of the frame before it was minimized.
See Also
IlvViewFrame::minimize, IlvViewFrame::getCurrentState
virtual void IlvDesktopManager::frameRestored ( IlvViewFrame frame,
int  previousState 
)
virtual

Is called by the desktop when a frame is restored.

The default implementation does nothing.

Parameters
frameThe restored frame.
previousStateThe state of the frame before it was restored.
See Also
IlvViewFrame::restore, IlvViewFrame::getCurrentState
virtual void IlvDesktopManager::frameSelectionChanged ( IlvViewFrame newFrame,
IlvViewFrame oldFrame 
)
virtual

Is called when the current frame changes.

The default implementation does nothing.

Parameters
newFrameThe new current frame.
oldFrameThe old current frame.
See Also
getCurrentFrame, setCurrentFrame
static IlvDesktopManager* IlvDesktopManager::Get ( IlvView view)
static

Returns the desktop manager linked to the specified view.

Parameters
viewThe view.
Returns
The desktop manager linked to view, or 0 if view is not a desktop view.
See Also
getView
virtual IlvPalette* IlvDesktopManager::getActiveTitleBarPalette ( ) const
virtual

Returns the palette used to draw the title bar of active frames.

You may override this method to change the color of the frame title bar.

Returns
The palette used to draw the title bar of active frames.
See Also
getInactiveTitleBarPalette
IlUInt IlvDesktopManager::getCardinal ( ) const

Returns the number of frames managed by the desktop.

Returns
The number of frames managed by the desktop.
See Also
getFrames, getFrame
IlvViewFrame* IlvDesktopManager::getCurrentFrame ( ) const

Returns the current frame.

Returns
The current frame, or 0 if there is none.
See Also
setCurrentFrame
IlvViewFrame* IlvDesktopManager::getFrame ( IlUInt  index) const

Returns a pointer to a frame of the desktop.

Parameters
indexThe index of the frame to be retrieved.
Returns
The frame whose index is specified.
See Also
getCardinal, getFrames
IlvViewFrame* const* IlvDesktopManager::getFrames ( IlUInt count) const

Returns an array of the frames managed by the desktop.

Parameters
countThe number of elements in the returned array.
Returns
An array containing the frames managed by the desktop. This array contains count elements. The returned array should never be modified or deleted.
See Also
getCardinal, getFrame
virtual IlvPalette* IlvDesktopManager::getInactiveTitleBarPalette ( ) const
virtual

Verbose:

Returns the palette used to draw the title bar of inactive frames. You may override this method to change the color of the frame title bar.

Returns
The palette used to draw the title bar of inactive frames.
See Also
getActiveTitleBarPalette
IlvViewFrame* const* IlvDesktopManager::getMinimizedFrames ( IlUInt count) const

Returns an array of the minimized frames of the desktop.

Parameters
countThe number of elements in the returned array.
Returns
An array containing the minimized frames managed by the desktop. This array contains count elements. The returned array should never be modified or deleted.
See Also
IlvViewFrame::minimize
IlvViewFrame* IlvDesktopManager::getNextFrame ( ) const

Returns the next frame, relative to the current frame.

Returns
The next frame, relative to the current frame. This method never returns 0, unless the desktop manager has no frames.
See Also
getCurrentFrame, getPreviousFrame
IlvViewFrame* IlvDesktopManager::getPreviousFrame ( ) const

Returns the previous frame, relative to the current frame.

Returns
The previous frame relative to the current frame. This method never returns 0, unless the desktop manager has no frames.
See Also
getCurrentFrame, getNextFrame
IlvView* IlvDesktopManager::getView ( ) const

Returns the desktop view of the desktop manager.

Returns
The view managed by this desktop manager.
See Also
Get
IlBoolean IlvDesktopManager::isMaximizing ( ) const

Indicates whether the desktop is maximized.

When the desktop manager is maximized, the title bar of the active frame is no longer visible because the client area of the active frame fits the desktop view. However, it is possible to tell the desktop manager to display some of the title bar components at a specific position. For details, see the method IlvDesktopManager::makeMaximizedStateButtons(IlvToolBar*).

Returns
IlTrue if the desktop is maximized, that is, if only one frame is visible and it occupies the whole desktop view.
See Also
getView, makeMaximizedStateButtons(IlvToolBar*)
virtual void IlvDesktopManager::makeMaximizedStateButtons ( IlvGraphicHolder holder,
IlvPos  vOffset = -1,
IlvPos  hOffset = -1 
)
virtual

Tells the desktop manager to place the frame buttons in a graphic holder when it is maximized.

Places in holder the buttons that will be used to change the state of the current frame when the desktop is maximized.

Parameters
holderThe graphic holder in which the desktop manager will display the frame buttons.
vOffsetThe vertical offset of the frame buttons from the top of the graphic holder.
hOffsetThe horizontal offset of the frame buttons from the right side of the graphic holder.
See Also
isMaximizing
virtual void IlvDesktopManager::makeMaximizedStateButtons ( IlvToolBar toolbar)
virtual

Tells the desktop manager to place the frame buttons in a tool bar when it is maximized.

Places in toolbar the buttons that will be used to change the state of the current frame when the desktop is maximized.

Parameters
toolbarThe tool bar in which the desktop manager will display the frame buttons.
See Also
isMaximizing, IlvToolBar
virtual void IlvDesktopManager::removeFrame ( IlvViewFrame frame)
virtual

Removes a frame from the desktop manager.

Usually, you do not have to call this method, as it is automatically called by the destructor of the IlvViewFrame class. However, you may need to use it in specific cases.

Parameters
frameThe view frame.
See Also
addFrame
virtual void IlvDesktopManager::setCurrentFrame ( IlvViewFrame frame,
IlBoolean  raise = IlTrue 
)
virtual

Changes the current frame.

The current frame of the desktop manager is the frame that is active.

Parameters
frameThe view frame.
raiseA Boolean value specifying whether the new active frame should be placed on top of the other frames.
See Also
getCurrentFrame
void IlvDesktopManager::tileFrames ( IlvDirection  direction)

Tiles the frames.

Parameters
directionThe tiling direction. Valid values are: IlvVertical and IlvHorizontal. This parameter is used only if there are at most three view frames in this desktop manager.
See Also
cascadeFrames

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