Hildon::Program Class Reference

#include <program.h>

Inheritance diagram for Hildon::Program:

List of all members.

Public Member Functions
virtual	~Program ()
HildonProgram *	gobj ()
	Provides access to the underlying C GObject.
const HildonProgram *	gobj () const
	Provides access to the underlying C GObject.
HildonProgram *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
	Program ()
void	add_window (Window &window)
	Registers a HildonWindow as belonging to a given HildonProgram .
void	remove_window (Window &window)
	Used to unregister a window from the program.
void	set_can_hibernate (bool killable=true)
	Used to set whether or not the Hildon task navigator should be able to set the program to hibernation in case of low memory.
bool	get_can_hibernate ()
void	set_common_menu (Gtk::Menu &menu)
	Sets a GtkMenu that will appear in all the HildonWindow registered to the Hildon::Program.
Gtk::Menu &	get_common_menu ()
void	set_common_toolbar (Gtk::Toolbar &toolbar)
	Sets a GtkToolbar that will appear in all the HildonWindow registered to the Hildon::Program.
Gtk::Toolbar &	get_common_toolbar ()
bool	get_is_topmost ()
Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Hildon::Program >	wrap (HildonProgram *object, bool take_copy=false)

---

Constructor & Destructor Documentation

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

Hildon::Program::Program (   )

---

Member Function Documentation

void Hildon::Program::add_window (  Window &  window  )

Registers a HildonWindow as belonging to a given HildonProgram . This allows to apply program-wide settings as all the registered windows, such as set_common_menu() and hildon_pogram_set_common_toolbar() Parameters: window  A HildonWindow to be added.

bool Hildon::Program::get_can_hibernate (   )

Returns: Whether or not this Hildon::Program is set to be support hibernation from the Hildon task navigator.

Gtk::Menu& Hildon::Program::get_common_menu (   )

Returns: The GtkMenu that was set as common menu for this Hildon::Program, or 0 of no common menu was set.

Gtk::Toolbar& Hildon::Program::get_common_toolbar (   )

Returns: The GtkToolbar that was set as common toolbar for this Hildon::Program, or 0 of no common menu was set.

bool Hildon::Program::get_is_topmost (   )

Returns: Whether or not one of the program's window or dialog is currenltly activated by the window manager.

const HildonProgram* Hildon::Program::gobj (   )  const [inline]

Provides access to the underlying C GObject.

HildonProgram* Hildon::Program::gobj (   )  [inline]

Provides access to the underlying C GObject.

HildonProgram* Hildon::Program::gobj_copy (   )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

void Hildon::Program::remove_window (  Window &  window  )

Used to unregister a window from the program. Subsequent calls to set_common_menu() and hildon_pogram_set_common_toolbar() will not affect the window Parameters: window  The HildonWindow to unregister.

void Hildon::Program::set_can_hibernate (  bool  killable = true  )

Used to set whether or not the Hildon task navigator should be able to set the program to hibernation in case of low memory. Parameters: can_hibernate  Whether or not the Hildon::Program can hibernate.

void Hildon::Program::set_common_menu (  Gtk::Menu &  menu  )

Sets a GtkMenu that will appear in all the HildonWindow registered to the Hildon::Program. Only one common GtkMenu can be set, further call will detach the previous common GtkMenu. A HildonWindow can use it's own GtkMenu with hildon_window_set_menu Parameters: menu  A GtkMenu to use as common menu for the program.

void Hildon::Program::set_common_toolbar (  Gtk::Toolbar &  toolbar  )

Sets a GtkToolbar that will appear in all the HildonWindow registered to the Hildon::Program. Only one common GtkToolbar can be set, further call will detach the previous common GtkToolbar. A HildonWindow can use its own GtkToolbar with hildon_window_set_toolbar . Both Hildon::Program and HildonWindow specific toolbars will be shown Parameters: toolbar  A GtkToolbar to use as common toolbar for the program.

---

Friends And Related Function Documentation

Glib::RefPtr< Hildon::Program > wrap (  HildonProgram *  object, bool  take_copy = false )  [related]

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:

• program.h

---