Hildon::Window Class Reference

Hildon::Window is a top-level window of an application running in the Hildon framework. More...

Inheritance diagram for Hildon::Window:

List of all members.

Public Member Functions

virtual ~Window ()

HildonWindow* gobj ()

Provides access to the underlying C GtkObject.

const HildonWindow* gobj () const

Provides access to the underlying C GtkObject.

Window ()

void add_with_scrollbar (Gtk::Widget& child)

Adds child to the Hildon::Window and creates a scrollbar for it.

void set_main_menu (Gtk::Menu& menu)

Sets the menu to be used for this window.

void unset_main_menu ()

Gtk::Menu* get_main_menu ()

Gets the Gtk::Menu assigned to the Hildon::Window.

const Gtk::Menu* get_main_menu () const

Gets the Gtk::Menu assigned to the Hildon::Window.

void set_app_menu (AppMenu& menu)

Sets the menu to be used for this window.

void unset_app_menu ()

AppMenu* get_app_menu ()

Returns: a Hildon::AppMenu.

const AppMenu* get_app_menu () const

Returns: a Hildon::AppMenu.

void add_toolbar (Gtk::Toolbar& toolbar)

Adds a toolbar to the window.

void remove_toolbar (Gtk::Toolbar& toolbar)

Removes a toolbar from the window.

void set_edit_toolbar (EditToolbar& toolbar)

Adds a Hildon::EditToolbar to the window.

void unset_edit_toolbar ()

bool get_is_topmost () const

Return value: true if self is currently activated, false otherwise.

Related Functions

(Note that these are not member functions.)

Hildon::Window* wrap (HildonWindow* object, bool take_copy=false)

A Glib::wrap() method for this object.

Detailed Description

Hildon::Window is a top-level window of an application running in the Hildon framework.

It provides facilities to manage window menus and toolbars.

Each Hildon::Window can have its own menu and toolbars. The application can also have a common menu and toolbar, which are shared among all application windows. For more information, see Hildon::Program.

The following methods are particularly important:

set_main_menu() sets a menu for the Hildon::Window.
add_toolbar() adds a toolbar for the Hildon::Window.

Constructor & Destructor Documentation

virtual Hildon::Window::~Window ( ) [virtual]

Reimplemented from Gtk::Window.

Hildon::Window::Window ( )

Member Function Documentation

HildonWindow* Hildon::Window::gobj ( ) [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

Reimplemented in Hildon::StackableWindow.

const HildonWindow* Hildon::Window::gobj ( ) const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

Reimplemented in Hildon::StackableWindow.

void Hildon::Window::add_with_scrollbar ( Gtk::Widget & child )

Adds child to the Hildon::Window and creates a scrollbar for it.

Similar to adding first a Gtk::ScrolledWindow and then child to it.

Parameters:

child

A Gtk::Widget.

void Hildon::Window::set_main_menu ( Gtk::Menu & menu )

Sets the menu to be used for this window.

This menu overrides a program-wide menu that may have been set with Hildon::Program::set_common_menu(). Pass 0 to remove the current menu. Hildon::Window takes ownership of the passed menu and you're not supposed to free it yourself anymore.

Note that if you're using a Hildon::AppMenu rather than a Gtk::Menu you should use set_app_menu() instead.

Parameters:

menu

The Gtk::Menu to be used for this Hildon::Window.

void Hildon::Window::unset_main_menu ( )

Gtk::Menu* Hildon::Window::get_main_menu ( )

Gets the Gtk::Menu assigned to the Hildon::Window.

Note that the window is still the owner of the menu.

Note that if you're using a Hildon::AppMenu rather than a Gtk::Menu you should use get_app_menu() instead.

Returns:: The Gtk::Menu assigned to this application view.

.

const Gtk::Menu* Hildon::Window::get_main_menu ( ) const

Gets the Gtk::Menu assigned to the Hildon::Window.

Note that the window is still the owner of the menu.

Note that if you're using a Hildon::AppMenu rather than a Gtk::Menu you should use get_app_menu() instead.

Returns:: The Gtk::Menu assigned to this application view.

.

void Hildon::Window::set_app_menu ( AppMenu& menu )

Sets the menu to be used for this window.

Pass 0 to remove the current menu. Any reference to a previous menu will be dropped. Hildon::Window takes ownership of the passed menu and you're not supposed to free it yourself anymore.

Note that if you're using a Gtk::Menu rather than a Hildon::AppMenu you should use set_main_menu() instead.

Parameters:

menu

A Hildon::AppMenu to be used for this window.

void Hildon::Window::unset_app_menu ( )

AppMenu* Hildon::Window::get_app_menu ( )

Returns: a Hildon::AppMenu.

Returns:: A Hildon::AppMenu

.

const AppMenu* Hildon::Window::get_app_menu ( ) const

Returns: a Hildon::AppMenu.

Returns:: A Hildon::AppMenu

.

void Hildon::Window::add_toolbar ( Gtk::Toolbar & toolbar )

Adds a toolbar to the window.

Note that the toolbar is not automatically shown. You need to call gtk_widget_show_all() on it to make it visible. It's also possible to hide the toolbar (without removing it) by calling gtk_widget_hide()

Parameters:

toolbar

A Gtk::Toolbar to add to the Hildon::Window.

void Hildon::Window::remove_toolbar ( Gtk::Toolbar & toolbar )

Removes a toolbar from the window.

Note that this decreases the refference count on the widget. If you want to keep the toolbar alive call Glib::object_ref() before calling this function.

Parameters:

toolbar

A Gtk::Toolbar to remove from the Hildon::Window.

void Hildon::Window::set_edit_toolbar ( EditToolbar& toolbar )

Adds a Hildon::EditToolbar to the window.

Note that the toolbar is not automatically shown. You need to call gtk_widget_show() on it to make it visible. It's also possible to hide the toolbar (without removing it) by calling gtk_widget_hide().

A window can only have at most one edit toolbar at a time, so the previous toolbar (if any) is replaced after calling this function.

Parameters:

toolbar A Hildon::EditToolbar, or 0 to remove the current one.

void Hildon::Window::unset_edit_toolbar ( )

bool Hildon::Window::get_is_topmost ( ) const

Return value: true if self is currently activated, false otherwise.

Returns:: true if self is currently activated, false otherwise.

Friends And Related Function Documentation

Hildon::Window* wrap	(	HildonWindow *	object,
		bool	take_copy = `false`
	)			`[related]`

A Glib::wrap() method for this object.

Parameters:

	object	The C instance.
	take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns:: A C++ instance that wraps this C instance.

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

window.h


Public Member Functions
virtual	~Window ()
HildonWindow*	gobj ()
	Provides access to the underlying C GtkObject.
const HildonWindow*	gobj () const
	Provides access to the underlying C GtkObject.
	Window ()
void	add_with_scrollbar (Gtk::Widget& child)
	Adds child to the Hildon::Window and creates a scrollbar for it.
void	set_main_menu (Gtk::Menu& menu)
	Sets the menu to be used for this window.
void	unset_main_menu ()
Gtk::Menu*	get_main_menu ()
	Gets the Gtk::Menu assigned to the Hildon::Window.
const Gtk::Menu*	get_main_menu () const
	Gets the Gtk::Menu assigned to the Hildon::Window.
void	set_app_menu (AppMenu& menu)
	Sets the menu to be used for this window.
void	unset_app_menu ()
AppMenu*	get_app_menu ()
	Returns: a Hildon::AppMenu.
const AppMenu*	get_app_menu () const
	Returns: a Hildon::AppMenu.
void	add_toolbar (Gtk::Toolbar& toolbar)
	Adds a toolbar to the window.
void	remove_toolbar (Gtk::Toolbar& toolbar)
	Removes a toolbar from the window.
void	set_edit_toolbar (EditToolbar& toolbar)
	Adds a Hildon::EditToolbar to the window.
void	unset_edit_toolbar ()
bool	get_is_topmost () const
	Return value: `true` if self is currently activated, `false` otherwise.
Related Functions
(Note that these are not member functions.)
Hildon::Window*	wrap (HildonWindow* object, bool take_copy=false)
	A Glib::wrap() method for this object.