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 IlvPalette *	getActiveTitleBarPalette () 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...

IlvViewFrame *	getCurrentFrame () const
	Returns the current frame. More...

IlvViewFrame *	getFrame (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 IlvPalette *	getInactiveTitleBarPalette () const
	Verbose: More...

IlvViewFrame const	getMinimizedFrames (IlUInt &count) const
	Returns an array of the minimized frames of the desktop. More...

IlvViewFrame *	getNextFrame () const
	Returns the next frame, relative to the current frame. More...

IlvViewFrame *	getPreviousFrame () const
	Returns the previous frame, relative to the current frame. More...

IlvView *	getView () 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 IlvDesktopManager *	Get (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::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

◆ addFrame()

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().

◆ cascadeFrames()

void IlvDesktopManager::cascadeFrames ( )

Cascades the frames.

See also: tileFrames().

◆ frameMaximized()

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().

◆ frameMinimized()

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().

◆ frameRestored()

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().

◆ frameSelectionChanged()

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().

◆ Get()

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().

◆ getActiveTitleBarPalette()

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().

◆ getCardinal()

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().

◆ getCurrentFrame()

IlvViewFrame* IlvDesktopManager::getCurrentFrame ( ) const

Returns the current frame.

Returns: The current frame, or 0 if there is none.

See also: setCurrentFrame().

◆ getFrame()

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().

◆ 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().

◆ getInactiveTitleBarPalette()

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().

◆ getMinimizedFrames()

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().

◆ getNextFrame()

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().

◆ 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().

◆ getView()

IlvView* IlvDesktopManager::getView ( ) const

Returns the desktop view of the desktop manager.

Returns: The view managed by this desktop manager.

See also: Get().

◆ isMaximizing()

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 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*).

◆ makeMaximizedStateButtons() [1/2]

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().

◆ makeMaximizedStateButtons() [2/2]

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

◆ removeFrame()

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().

◆ setCurrentFrame()

virtual void IlvDesktopManager::setCurrentFrame	(	IlvViewFrame *	frame,
		IlBoolean	raise = `IlTrue`
	)

virtual

Changes the current frame.

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

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().

◆ tileFrames()

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().

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ IlvDesktopManager()

Member Function Documentation

◆ addFrame()

◆ cascadeFrames()

◆ frameMaximized()

◆ frameMinimized()

◆ frameRestored()

◆ frameSelectionChanged()

◆ Get()

◆ getActiveTitleBarPalette()

◆ getCardinal()

◆ getCurrentFrame()

◆ getFrame()

◆ getFrames()

◆ getInactiveTitleBarPalette()

◆ getMinimizedFrames()

◆ getNextFrame()

◆ getPreviousFrame()

◆ getView()

◆ isMaximizing()

◆ makeMaximizedStateButtons() [1/2]

◆ makeMaximizedStateButtons() [2/2]

◆ removeFrame()

◆ setCurrentFrame()

◆ tileFrames()