gtkmm-utils 0.4.1
Gtk::Util::PageNavigator Class Reference

Navigation bar. More...

Inheritance diagram for Gtk::Util::PageNavigator:

List of all members.

Public Types

typedef sigc::signal< void > SignalNavigation
 Signal emmitted when a page navigation request has been made.

Public Member Functions

virtual Gtk::Button & get_button_first ()
 Returns a button for navigating to the first page.
virtual Gtk::Button & get_button_last ()
 Returns a button for navigating to the last page.
virtual Gtk::Button & get_button_next ()
 Returns a button for navigating to the next page.
virtual Gtk::Button & get_button_previous ()
 Returns a button for navigating to the previous page.
 PageNavigator ()
 Constructs a new PageNavigator.
virtual void set_page_info (const Glib::ustring &info)
 Sets text on a lable which is meant to display page information.
virtual void set_title (const Glib::ustring &title)
 Sets a title for the navigation bar.
virtual void set_title_markup (const Glib::ustring &marked_up_title)
 Sets a custom markup on the title in the bar.
SignalNavigationsignal_first ()
 Returns a SignalNavigation for requests to the first page, which you can connect to.
SignalNavigationsignal_last ()
 Returns a SignalNavigation for requests to the last page, which you can connect to.
SignalNavigationsignal_next ()
 Returns a SignalNavigation for requests to a next page, which you can connect to.
SignalNavigationsignal_previous ()
 Returns a SignalNavigation for requests to a previous page, which you can connect to.
virtual ~PageNavigator ()
 PageNavigator destructor.

Protected Member Functions

virtual bool on_scroll_event (GdkEventScroll *event)

Protected Attributes

std::auto_ptr< Private > priv_

Detailed Description

Navigation bar.

Used for composing a TileView, otherwise it is completely generic and can be used to display navigation of any kind of page-like view.

The widget is composed of a title label, page information label, and buttons which should lead the user to a next or previous page in the view. Use of labels is optional. The title label should describe the information being displayed in a view using this navigation bar. The page information label should inform the user of the current position, ie its value should be dynamically updated to something like 'x - y of z'.


Member Typedef Documentation

typedef sigc::signal<void> Gtk::Util::PageNavigator::SignalNavigation

Signal emmitted when a page navigation request has been made.

This could be when a corresponding button has been clicked on, or when a mouse wheel is scrolled down within the navigation bar.


Constructor & Destructor Documentation

Gtk::Util::PageNavigator::PageNavigator ( ) [explicit]

Constructs a new PageNavigator.

virtual Gtk::Util::PageNavigator::~PageNavigator ( ) [virtual]

PageNavigator destructor.


Member Function Documentation

virtual Gtk::Button& Gtk::Util::PageNavigator::get_button_first ( ) [virtual]

Returns a button for navigating to the first page.

Returns:
a Gtk::Button reference
virtual Gtk::Button& Gtk::Util::PageNavigator::get_button_last ( ) [virtual]

Returns a button for navigating to the last page.

Returns:
a Gtk::Button reference
virtual Gtk::Button& Gtk::Util::PageNavigator::get_button_next ( ) [virtual]

Returns a button for navigating to the next page.

Returns:
a Gtk::Button reference
virtual Gtk::Button& Gtk::Util::PageNavigator::get_button_previous ( ) [virtual]

Returns a button for navigating to the previous page.

Returns:
a Gtk::Button reference
virtual bool Gtk::Util::PageNavigator::on_scroll_event ( GdkEventScroll *  event) [protected, virtual]
virtual void Gtk::Util::PageNavigator::set_page_info ( const Glib::ustring &  info) [virtual]

Sets text on a lable which is meant to display page information.

This label appears next to the label containing the title. Compose a string such as '11 - 20 / 23' and pass it here.

Parameters:
infoa string to describe current location in a page view
virtual void Gtk::Util::PageNavigator::set_title ( const Glib::ustring &  title) [virtual]

Sets a title for the navigation bar.

Parameters:
titlea string
virtual void Gtk::Util::PageNavigator::set_title_markup ( const Glib::ustring &  marked_up_title) [virtual]

Sets a custom markup on the title in the bar.

Parameters:
marked_up_titleescaped markup string; escape strings with Glib::Markup::escape_text()
SignalNavigation& Gtk::Util::PageNavigator::signal_first ( )

Returns a SignalNavigation for requests to the first page, which you can connect to.

Returns:
a SignalNavigation reference
SignalNavigation& Gtk::Util::PageNavigator::signal_last ( )

Returns a SignalNavigation for requests to the last page, which you can connect to.

Returns:
a SignalNavigation reference
SignalNavigation& Gtk::Util::PageNavigator::signal_next ( )

Returns a SignalNavigation for requests to a next page, which you can connect to.

Returns:
a SignalNavigation reference
SignalNavigation& Gtk::Util::PageNavigator::signal_previous ( )

Returns a SignalNavigation for requests to a previous page, which you can connect to.

Returns:
a SignalPrevious reference

Member Data Documentation

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

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