IlvDesktopManager Class Reference

Desktop class. More...

#include <ilviews/gadgets/desktop.h>

List of all members.

Public Member Functions
	IlvDesktopManager (IlvView *view)
	Constructor.
virtual void	addFrame (IlvViewFrame *frame)
	Adds a frame to the desktop manager.
void	cascadeFrames ()
	Cascades the frames.
virtual void	frameMaximized (IlvViewFrame *frame, int previousState)
	Is called by the desktop when a frame is maximized.
virtual void	frameMinimized (IlvViewFrame *frame, int previousState)
	Is called by the desktop when a frame is minimized.
virtual void	frameRestored (IlvViewFrame *frame, int previousState)
	Is called by the desktop when a frame is restored.
virtual void	frameSelectionChanged (IlvViewFrame *newFrame, IlvViewFrame *oldFrame)
	Is called when the current frame changes.
virtual IlvPalette *	getActiveTitleBarPalette () const
	Returns the palette used to draw the title bar of active frames.
IlUInt	getCardinal () const
	Returns the number of frames managed by the desktop.
IlvViewFrame *	getCurrentFrame () const
	Returns the current frame.
IlvViewFrame *	getFrame (IlUInt index) const
	Returns a pointer to a frame of the desktop.
IlvViewFrame *const *	getFrames (IlUInt &count) const
	Returns an array of the frames managed by the desktop.
virtual IlvPalette *	getInactiveTitleBarPalette () const
	Verbose:.
IlvViewFrame *const *	getMinimizedFrames (IlUInt &count) const
	Returns an array of the minimized frames of the desktop.
IlvViewFrame *	getNextFrame () const
	Returns the next frame, relative to the current frame.
IlvViewFrame *	getPreviousFrame () const
	Returns the previous frame, relative to the current frame.
IlvView *	getView () const
	Returns the desktop view of the desktop manager.
IlBoolean	isMaximizing () const
	Indicates whether the desktop is maximized.
virtual void	makeMaximizedStateButtons (IlvToolBar *toolbar)
	Tells the desktop manager to place the frame buttons in a tool bar when it is maximized.
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.
virtual void	removeFrame (IlvViewFrame *frame)
	Removes a frame from the desktop manager.
virtual void	setCurrentFrame (IlvViewFrame *frame, IlBoolean raise=IlTrue)
	Changes the current frame.
void	tileFrames (IlvDirection direction)
	Tiles the frames.
Static Public Member Functions
static IlvDesktopManager *	Get (IlvView *view)
	Returns the desktop manager linked to the specified view.
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:

view

The 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:

frame

The 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:

	frame	The maximized frame.
	previousState	The 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:

	frame	The minimized frame.
	previousState	The 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:

	frame	The restored frame.
	previousState	The 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:

	newFrame	The new current frame.
	oldFrame	The old current frame.

See also:

getCurrentFrame, setCurrentFrame

static IlvDesktopManager* IlvDesktopManager::Get

(

IlvView *

view

)

[static]

Returns the desktop manager linked to the specified view.

Parameters:

view

The 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:

index

The 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:

count

The 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:

count

The 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

(

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:

toolbar

The tool bar in which the desktop manager will display the frame buttons.

See also:

isMaximizing, 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:

	holder	The graphic holder in which the desktop manager will display the frame buttons.
	vOffset	The vertical offset of the frame buttons from the top of the graphic holder.
	hOffset	The horizontal offset of the frame buttons from the right side of the graphic holder.

See also:

isMaximizing

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:

frame

The 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:

	frame	The view frame.
	raise	A 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:

direction

The 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