Gtk::Util::TileView Class Reference

The Tile container. More...

Inheritance diagram for Gtk::Util::TileView:

[legend]

List of all members.

Public Types
typedef sigc::signal< void, Tile & >	SignalTileActivated
	Signal emmitted when user double-clicks, or pressed the Return key on a Tile in the container.
typedef sigc::slot< void, Tile & >	SlotForEachTile
	Slot used to iterate over child Tile widgets.
Public Member Functions
virtual void	add_tile (Tile *tile)
	Adds and shows a Tile in the container.
virtual void	add_tile (Tile &tile)
	Adds and shows a Tile in the container.
virtual void	clear ()
	Removes all child tiles and clears internal data.
virtual void	for_each_tile (const SlotForEachTile &slot)
	Calls a supplied function for each child Tile.
virtual PageNavigator &	get_page_navigator ()
	Returns the contained PageNavigator widget.
virtual Tile *	get_selection ()
	Returns the last selected Tile, or null of none is selected.
virtual int	get_tiles_per_page () const
	Gets the current number of tiles displayed in one page.
virtual void	reset_selection ()
	Resets current selection in the view.
virtual void	set_navigator_title (const Glib::ustring &title)
	Sets a custom title in the TilePageNavigator above the content.
virtual void	set_navigator_title_markup (const Glib::ustring &marked_up_title)
	Sets a custom markup on the title in the TilePageNavigator above the content.
virtual void	set_page_view (bool use_page_view=true)
	Sets the display style.
virtual void	set_tiles_per_page (int tiles_per_page)
	Sets the number of tiles displayed in one page.
virtual void	show_page_navigator (bool show=true)
	Shows or hides a TilePageNavigator above the content.
SignalTileActivated &	signal_tile_activated ()
	Returns the SignalActivated, which you can connect to.
	TileView (bool use_page_view=true)
	Constructs a new TileView.
virtual	~TileView ()
	TileView destructor.
Protected Member Functions
virtual bool	on_key_press_event (GdkEventKey *event)
virtual void	on_show_request ()
	called when child widget(s) request to be shown.
Protected Attributes
std::auto_ptr< Private >	priv_

---

Detailed Description

The Tile container.

---

Member Typedef Documentation

typedef sigc::signal<void, Tile&> Gtk::Util::TileView::SignalTileActivated

Signal emmitted when user double-clicks, or pressed the Return key on a Tile in the container.

The signal passes a reference to the Tile that has been activated.

typedef sigc::slot<void, Tile&> Gtk::Util::TileView::SlotForEachTile

Slot used to iterate over child Tile widgets.

See also:

for_each_tile()

---

Constructor & Destructor Documentation

Gtk::Util::TileView::TileView

(

bool

use_page_view = true

)

[explicit]

Constructs a new TileView.

Parameters:

use_page_view

when true, indicates that tiles should be separated into pages; when false, all tiles will be displayed at once.

virtual Gtk::Util::TileView::~TileView

(

)

[virtual]

TileView destructor.

---

Member Function Documentation

virtual void Gtk::Util::TileView::add_tile

(

Tile *

tile

)

[virtual]

Adds and shows a Tile in the container.

Parameters:

tile

a Tile pointer

virtual void Gtk::Util::TileView::add_tile

(

Tile &

tile

)

[virtual]

Adds and shows a Tile in the container.

Parameters:

tile

a Tile reference

virtual void Gtk::Util::TileView::clear

(

)

[virtual]

Removes all child tiles and clears internal data.

virtual void Gtk::Util::TileView::for_each_tile

(

const SlotForEachTile &

slot

)

[virtual]

Calls a supplied function for each child Tile.

Parameters:

slot

user function to call

virtual PageNavigator& Gtk::Util::TileView::get_page_navigator

(

)

[virtual]

Returns the contained PageNavigator widget.

Returns:

a PageNavigator reference

virtual Tile* Gtk::Util::TileView::get_selection

(

)

[virtual]

Returns the last selected Tile, or null of none is selected.

Returns:

a pointer to Tile.

virtual int Gtk::Util::TileView::get_tiles_per_page

(

)

const [virtual]

Gets the current number of tiles displayed in one page.

Returns:

the number of tiles displayed in one page

virtual bool Gtk::Util::TileView::on_key_press_event

(

GdkEventKey *

event

)

[protected, virtual]

virtual void Gtk::Util::TileView::on_show_request

(

)

[protected, virtual]

called when child widget(s) request to be shown.

This occurs after a new Tile has been added.

virtual void Gtk::Util::TileView::reset_selection

(

)

[virtual]

Resets current selection in the view.

virtual void Gtk::Util::TileView::set_navigator_title

(

const Glib::ustring &

title

)

[virtual]

Sets a custom title in the TilePageNavigator above the content.

Parameters:

title

a string

virtual void Gtk::Util::TileView::set_navigator_title_markup

(

const Glib::ustring &

marked_up_title

)

[virtual]

Sets a custom markup on the title in the TilePageNavigator above the content.

Parameters:

marked_up_title

escaped markup string; escape strings with Glib::Markup::escape_text()

virtual void Gtk::Util::TileView::set_page_view

(

bool

use_page_view = true

)

[virtual]

Sets the display style.

Parameters:

use_page_view

when true, indicates that tiles should be separated into pages; when false, all tiles will be displayed at once

virtual void Gtk::Util::TileView::set_tiles_per_page

(

int

tiles_per_page

)

[virtual]

Sets the number of tiles displayed in one page.

Parameters:

tiles_per_page

a new number of tiles to be displayed in one page

virtual void Gtk::Util::TileView::show_page_navigator

(

bool

show = true

)

[virtual]

Shows or hides a TilePageNavigator above the content.

Parameters:

show

indicates whether to show or hide the navigation bar

SignalTileActivated& Gtk::Util::TileView::signal_tile_activated

(

)

Returns the SignalActivated, which you can connect to.

Returns:

a reference to the TileView's SignalActivated.

---

Member Data Documentation

std::auto_ptr<Private> Gtk::Util::TileView::priv_ [protected]

---

The documentation for this class was generated from the following file:

• tile-view.h