Maeomm Reference Documentation: hildonsmm
Main Page   Namespaces   Book  

Hildon::Window Class Reference

Inheritance diagram for Hildon::Window:

Gtk::Window Gtk::Bin Gtk::Container Gtk::Widget Gtk::Object Atk::Implementor Glib::Object Glib::Interface Glib::ObjectBase Glib::ObjectBase sigc::trackable sigc::trackable 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 to it.
bool get_is_topmost () const
 
Returns:
Whether or not the Hildon::Window is currenltly activated by the window manager.

const Gtk::Menuget_menu () const
 Gets the Gt::Menu assigned to the Hildon::Appview.
Gtk::Menuget_menu ()
 Gets the Gt::Menu assigned to the Hildon::Appview.
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_menu (Gtk::Menu& menu)
 Sets the menu to be used for this window.
 Window ()
virtual ~Window ()

Related Functions

(Note that these are not member functions.)

Hildon::Windowwrap (HildonWindow* object, bool take_copy=false)
 
Parameters:
object The C instance


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.

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 to it.

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

Parameters:
child A GtkWidget .

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_menu (  )  const

Gets the Gt::Menu assigned to the Hildon::Appview.

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

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

Gets the Gt::Menu assigned to the Hildon::Appview.

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

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

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

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

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

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

Removes a toolbar from the window.

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

void Hildon::Window::set_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.

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


Friends And Related Function Documentation

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

Parameters:
object The C instance

Parameters:
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.1 © 1997-2001