Hildon::App Class Reference

#include <app.h>

Inheritance diagram for Hildon::App:

List of all members.

Public Member Functions
virtual	~App ()
HildonApp *	gobj ()
	Provides access to the underlying C GtkObject.
const HildonApp *	gobj () const
	Provides access to the underlying C GtkObject.
	App ()
	App (AppView &appview)
void	set_appview (AppView &appview)
	Sets (switches to) appview.
AppView *	get_appview ()
	Gets the currently shown appview.
const AppView *	get_appview () const
	Gets the currently shown appview.
void	set_title (const Glib::ustring &newtitle)
	Sets title of the application.
Glib::ustring	get_title () const
	Gets the title of the application.
Glib::SignalProxy0< void >	signal_topmost_status_acquire ()
Glib::SignalProxy0< void >	signal_topmost_status_lose ()
Glib::SignalProxy0< void >	signal_switch_to ()
Glib::SignalProxy0< void >	signal_im_close ()
Glib::SignalProxy1< void, Gtk::Widget * >	signal_clipboard_copy ()
Glib::SignalProxy1< void, Gtk::Widget * >	signal_clipboard_cut ()
Glib::SignalProxy1< void, Gtk::Widget * >	signal_clipboard_paste ()
void	set_two_part_title (bool istwoparttitle=true)
	Sets the two part title.
bool	get_two_part_title () const
	Gets the 'twopart' represention of the title inside Hildon::App.
void	set_autoregistration (bool auto_reg=true)
	Controls the autoregistration/unregistration of (app)views.
void	register_view (gpointer view_ptr)
	Registers a new view.
bool	register_view (gpointer view_ptr, gulong view_id)
	Registers a new view.
void	unregister_view (gpointer view_ptr)
	Unregisters a view from HildonApp.
void	unregister_view (gulong view_id)
	Unregisters a view with specified ID, if it exists.
void	notify_view_changed (gpointer view_ptr)
	Updates the X property that contains the currently active view.
void	set_killable (bool killability=true)
	Updates information about whether the application can be killed or not by Task Navigator (i.e. whether its statesave is up to date).
void	set_ui_manager (const Glib::RefPtr< Gtk::UIManager > &uim)
	Sets the Gtk::UIManager assigned to the Hildon::App.
Glib::RefPtr< Gtk::UIManager >	get_ui_manager ()
	Gets the Gtk::UIManager assigned to the Hildon::App.
Glib::RefPtr< const Gtk::UIManager >	get_ui_manager () const
	Gets the Gtk::UIManager assigned to the Hildon::App.
Related Functions
(Note that these are not member functions.)
Hildon::App *	wrap (HildonApp *object, bool take_copy=false)

---

Constructor & Destructor Documentation

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

Hildon::App::App (   )

Hildon::App::App (  AppView &  appview  )  [explicit]

---

Member Function Documentation

const AppView* Hildon::App::get_appview (   )  const

Gets the currently shown appview. Returns: the currently shown appview in this HildonApp. If no appview is currently set for this HildonApp, Returns: 0.

AppView* Hildon::App::get_appview (   )

Gets the currently shown appview. Returns: the currently shown appview in this HildonApp. If no appview is currently set for this HildonApp, Returns: 0.

Glib::ustring Hildon::App::get_title (   )  const

Gets the title of the application. Returns: The title currently assigned to the application. This value is not to be freed or modified by the calling application.

bool Hildon::App::get_two_part_title (   )  const

Gets the 'twopart' represention of the title inside Hildon::App. Returns: A boolean indicating wheter title shown has both application, and application view title separated by a triangle.

Glib::RefPtr<const Gtk::UIManager> Hildon::App::get_ui_manager (   )  const

Gets the Gtk::UIManager assigned to the Hildon::App. Returns: The Gtk::UIManager assigned to this application or null if no manager is assigned.

Glib::RefPtr<Gtk::UIManager> Hildon::App::get_ui_manager (   )

Gets the Gtk::UIManager assigned to the Hildon::App. Returns: The Gtk::UIManager assigned to this application or null if no manager is assigned.

const HildonApp* Hildon::App::gobj (   )  const [inline]

Provides access to the underlying C GtkObject.

HildonApp* Hildon::App::gobj (   )  [inline]

Provides access to the underlying C GtkObject.

void Hildon::App::notify_view_changed (  gpointer  view_ptr  )

Updates the X property that contains the currently active view. Parameters: view_ptr  Pointer to the view that is switched to.

bool Hildon::App::register_view (  gpointer  view_ptr, gulong  view_id )

Registers a new view. Allows the application to specify any ID. Parameters: view_ptr  Pointer to the view instance to be registered. view_id  The ID of the view. Returns: true if the view registration succeeded, false otherwise. The probable cause of failure is that view with that ID already existed.

void Hildon::App::register_view (  gpointer  view_ptr  )

Registers a new view. For appviews, this can be done automatically if autoregistration is set. Parameters: view_ptr  Pointer to the view instance to be registered.

void Hildon::App::set_appview (  AppView &  appview  )

Sets (switches to) appview. Parameters: appview  A Hildon::AppView.

void Hildon::App::set_autoregistration (  bool  auto_reg = true  )

Controls the autoregistration/unregistration of (app)views. Parameters: auto_reg  Whether the (app)view autoregistration should be active.

void Hildon::App::set_killable (  bool  killability = true  )

Updates information about whether the application can be killed or not by Task Navigator (i.e. whether its statesave is up to date). Parameters: killability  Truth value indicating whether the app can be killed.

void Hildon::App::set_title (  const Glib::ustring &  newtitle  )

Sets title of the application. Parameters: newtitle  The new title assigned to the application.

void Hildon::App::set_two_part_title (  bool  istwoparttitle = true  )

Sets the two part title. Parameters: istwoparttitle  A bool indicating wheter to activate a title that has both the application title and application view title separated by a triangle.

void Hildon::App::set_ui_manager (  const Glib::RefPtr< Gtk::UIManager > &  uim  )

Sets the Gtk::UIManager assigned to the Hildon::App. If uim is 0, unsets the current ui manager. The HildonApp holds a reference to the ui manager until the HildonApp is destroyed or unset. Parameters: uim  Gtk::UIManager to be set.

Glib::SignalProxy1< void,Gtk::Widget* > Hildon::App::signal_clipboard_copy (   )

Glib::SignalProxy1< void,Gtk::Widget* > Hildon::App::signal_clipboard_cut (   )

Glib::SignalProxy1< void,Gtk::Widget* > Hildon::App::signal_clipboard_paste (   )

Glib::SignalProxy0< void > Hildon::App::signal_im_close (   )

Glib::SignalProxy0< void > Hildon::App::signal_switch_to (   )

Glib::SignalProxy0< void > Hildon::App::signal_topmost_status_acquire (   )

Glib::SignalProxy0< void > Hildon::App::signal_topmost_status_lose (   )

void Hildon::App::unregister_view (  gulong  view_id  )

Unregisters a view with specified ID, if it exists. Parameters: view_id  The ID of the view that should be unregistered.

void Hildon::App::unregister_view (  gpointer  view_ptr  )

Unregisters a view from HildonApp. Done usually when a view is destroyed. For appviews, this is can be automatically if autoregistration is set. Parameters: view_ptr  Pointer to the view instance to be unregistered.

---

Friends And Related Function Documentation

Hildon::App * wrap (  HildonApp *  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:

• app.h

---