Maeomm Reference Documentation: hildonsmm
Main Page   Namespaces   Book  

Hildon::Window Class Reference

Inheritance diagram for Hildon::Window:

Inheritance graph
[legend]

List of all members.


Detailed Description

Hildon::Window represents 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:


Public Member Functions

void add_toolbar (Gtk::Toolbar& toolbar)
 Adds a toolbar to the window.
void add_with_scrollbar (Gtk::Widget& child)
 Adds the child to the HildonWindow and creates a scrollbar for it.
const AppMenuget_app_menu () const
AppMenuget_app_menu ()
bool get_is_topmost () const
const Gtk::Menuget_main_menu () const
Gtk::Menuget_main_menu ()
const HildonWindow* gobj () const
 Provides access to the underlying C GtkObject.
HildonWindow* gobj ()
 Provides access to the underlying C GtkObject.
void remove_toolbar (Gtk::Toolbar& toolbar)
 Removes a toolbar from the window.
void set_app_menu (AppMenu& menu)
void set_edit_toolbar (EditToolbar& toolbar)
void set_main_menu (Gtk::Menu& menu)
 Sets the menu to be used for this window.
void unset_app_menu ()
void unset_edit_toolbar ()
void unset_main_menu ()
 Window ()
virtual ~Window ()

Related Functions

(Note that these are not member functions.)

Hildon::Windowwrap (HildonWindow* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Constructor & Destructor Documentation

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

Reimplemented from Gtk::Window.

Hildon::Window::Window (  ) 


Member Function Documentation

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 HildonWindow.

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

Adds the child to the HildonWindow and creates a scrollbar for it.

Similar as adding first a GtkScrolledWindow and then the child to it.

Parameters:
child A GtkWidget.

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

AppMenu* Hildon::Window::get_app_menu (  ) 

bool Hildon::Window::get_is_topmost (  )  const

Returns:
Whether or not the Hildon::Window is currenltly activated by the window manager.

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

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

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

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

Reimplemented in Hildon::StackableWindow.

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

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

Reimplemented in Hildon::StackableWindow.

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 g_object_ref before calling this function.

Parameters:
toolbar A Gtk::Toolbar to remove from the HildonWindow.

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

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

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.

Since: Hildon 2.2

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

void Hildon::Window::unset_app_menu (  ) 

void Hildon::Window::unset_edit_toolbar (  ) 

void Hildon::Window::unset_main_menu (  ) 


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:

Generated for hildonmm by Doxygen 1.5.6 © 1997-2001