IlvToolBarPath Class Reference

ToolBar class which displays a path like a set of pop-up menus. More...

#include <ilviews/gadgets/toolpath.h>

Inheritance diagram for IlvToolBarPath:

List of all members.

Public Member Functions
	IlvToolBarPath (IlvDisplay *display, const IlvRect &rect)
	Constructor.
virtual void	changeDir (const IlPathName &path)
	Called when the user selects a new path.
virtual IlvPopupMenu *	createDeviceMenu (const IlString &current)
	Creates a device pop-up menu.
virtual IlvPopupMenu *	createDirectoryMenu (const IlPathName &path)
	Creates a directory pop-up menu.
virtual IlvMenuItemPath *	createMenuItem (const IlString &label, const IlPathName &path, IlvPopupMenu *submenu=0)
	Creates a menu item.
const char *	getPath () const
	Returns the path.
virtual void	rewindDir (const IlPathName &path)
	Called when the user selects a directory in the path.
void	setChangeDirCallback (IlvToolBarPathCallback cb, IlAny arg=0)
	Sets the callback invoked when the user selects a new path.
virtual void	setPath (const IlPathName &path)
	Sets the path.
void	setRewindCallback (IlvToolBarPathCallback cb, IlAny arg=0)
	Sets the callback invoked when the user selects a directory in the path.

---

Detailed Description

ToolBar class which displays a path like a set of pop-up menus.

Library: ilvadvgdt

This toolbar class displays a path as a set of pop-up menus. Each directory of the path becomes a button of the toolbar. Between each button, a pop-up menu displays the directory list from the same level as the path associated with the button. When the user clicks a button or chooses a menu entry, a callback is invoked with the path chosen by the user. Note: This class has been designed for the IlvFileChooser dialog. It cannot be saved into an Ilv file.

See also:

IlvMenuItemPath, IlvFileChooser

---

Constructor & Destructor Documentation

IlvToolBarPath::IlvToolBarPath	(	IlvDisplay *	display,
		const IlvRect &	rect
	)

Constructor.

Initializes a new instance of the IlvToolBarPath class.

Parameters:

	display	The connection to the display.
	rect	The size and position of the toolbar.

---

Member Function Documentation

virtual void IlvToolBarPath::changeDir

(

const IlPathName &

path

)

[virtual]

Called when the user selects a new path.

Called when the user selects a new path from a pop-up menu.

Parameters:

path

The path which corresponds to the selection.

virtual IlvPopupMenu* IlvToolBarPath::createDeviceMenu

(

const IlString &

current

)

[virtual]

Creates a device pop-up menu.

Returns a new pop-up menu whichs contains the different devices. On Unix platforms, this method returns 0 because the devices are specific to Windows.

Parameters:

current

The current device of the current path.

Returns:

A new pop-up menu which contains the different devices.

virtual IlvPopupMenu* IlvToolBarPath::createDirectoryMenu

(

const IlPathName &

path

)

[virtual]

Creates a directory pop-up menu.

Returns a new pop-up menu whichs contains the directories in the path. The directories named . and .. are ignored.

Parameters:

path

The path

Returns:

A new pop-up menu whichs contains the directories in the path.

virtual IlvMenuItemPath* IlvToolBarPath::createMenuItem	(	const IlString &	label,
		const IlPathName &	path,
		IlvPopupMenu *	submenu = 0
	)			[virtual]

Creates a menu item.

Creates a new menu item.

Parameters:

	label	The label of the menu item.
	path	The path associated with the menu item.
	submenu	The list of directories.

Returns:

A new menu item.

const char* IlvToolBarPath::getPath

(

)

const

Returns the path.

Returns:

The full path displayed by the toolbar.

virtual void IlvToolBarPath::rewindDir

(

const IlPathName &

path

)

[virtual]

Called when the user selects a directory in the path.

Called when the user selects a directory or the device of the current path.

Parameters:

path

The path which corresponds to the selection.

void IlvToolBarPath::setChangeDirCallback	(	IlvToolBarPathCallback	cb,
		IlAny	arg = 0
	)

Sets the callback invoked when the user selects a new path.

Sets the callback invoked when the user selects a new path from a pop-up menu.

Parameters:

	cb	The callback.
	arg	The user parameter that was provided to the member function that calls this function.

virtual void IlvToolBarPath::setPath

(

const IlPathName &

path

)

[virtual]

Sets the path.

Sets the full path to display as a set of buttons and pop-up menus.

Parameters:

path

The path.

void IlvToolBarPath::setRewindCallback	(	IlvToolBarPathCallback	cb,
		IlAny	arg = 0
	)

Sets the callback invoked when the user selects a directory in the path.

Sets the callback invoked when the user selects a directory or the device of the current path.

Parameters:

	cb	The callback.
	arg	The user parameter that was provided to the member function that calls this function.