|
|
|
hildon 2.1.24 Reference Manual | |
|---|---|---|---|---|
HildonProgramHildonProgram — An object that represents an application running in the Hildon framework. |
HildonProgram;
HildonProgram* hildon_program_get_instance (void);
void hildon_program_add_window (HildonProgram *self,
HildonWindow *window);
void hildon_program_remove_window (HildonProgram *self,
HildonWindow *window);
void hildon_program_set_can_hibernate (HildonProgram *self,
gboolean can_hibernate);
gboolean hildon_program_get_can_hibernate (HildonProgram *self);
void hildon_program_set_common_menu (HildonProgram *self,
GtkMenu *menu);
GtkMenu* hildon_program_get_common_menu (HildonProgram *self);
void hildon_program_set_common_toolbar (HildonProgram *self,
GtkToolbar *toolbar);
GtkToolbar* hildon_program_get_common_toolbar (HildonProgram *self);
gboolean hildon_program_get_is_topmost (HildonProgram *self);
HildonStackableWindow* hildon_program_pop_window_stack (HildonProgram *self);
HildonStackableWindow* hildon_program_peek_window_stack (HildonProgram *self);
void hildon_program_go_to_root_window (HildonProgram *self);
The HildonProgram is an object used to represent an application running in the Hildon framework.
Such an application is thought to have one or more HildonWindow. These
shall be registered to the HildonProgram with hildon_program_add_window(),
and can be unregistered similarly with hildon_program_remove_window().
The HildonProgram provides the programmer with commodities such
as applying a common toolbar and menu to all the HildonWindow
registered to it. This is done with hildon_program_set_common_menu()
and hildon_program_set_common_toolbar().
The HildonProgram is also used to apply program-wide properties that
are specific to the Hildon framework. For instance
hildon_program_set_can_hibernate() sets whether or not an application
can be set to hibernate by the Hildon task navigator, in situations of
low memory.
The HildonProgram also contains a stack of
HildonStackableWindow. Such windows will be automatically added to
the stack when shown, and removed when destroyed. The developer can
use the stack with hildon_program_pop_window_stack(),
hildon_program_peek_window_stack() and hildon_program_go_to_root_window().
Example 3.
HildonProgram *program; HildonWindow *window1; HildonWindow *window2; GtkToolbar *common_toolbar, *window_specific_toolbar; GtkMenu *menu; program = HILDON_PROGRAM (hildon_program_get_instance ()); window1 = HILDON_WINDOW (hildon_window_new ()); window2 = HILDON_WINDOW (hildon_window_new ()); common_toolbar = create_common_toolbar (); window_specific_toolbar = create_window_specific_toolbar (); menu = create_menu (); hildon_program_add_window (program, window1); hildon_program_add_window (program, window2); hildon_program_set_common_menu (program, menu); hildon_program_set_common_toolbar (program, common_toolbar); hildon_window_add_toolbar (window1, window_specific_toolbar); hildon_program_set_can_hibernate (program, TRUE);
HildonProgram* hildon_program_get_instance (void);
| Returns : | Returns the HildonProgram for the current process. The object is created on the first call. Note that you're not supposed to unref the returned object since it's not reffed in the first place. |
void hildon_program_add_window (HildonProgram *self, HildonWindow *window);
Registers a HildonWindow as belonging to a given HildonProgram. This
allows to apply program-wide settings as all the registered windows,
such as hildon_program_set_common_menu() and
hildon_pogram_set_common_toolbar()
self : |
The HildonProgram to which the window should be registered |
window : |
A HildonWindow to be added |
void hildon_program_remove_window (HildonProgram *self, HildonWindow *window);
Used to unregister a window from the program. Subsequent calls to
hildon_program_set_common_menu() and hildon_pogram_set_common_toolbar()
will not affect the window
self : |
The HildonProgram to which the window should be unregistered |
window : |
The HildonWindow to unregister
|
void hildon_program_set_can_hibernate (HildonProgram *self, gboolean can_hibernate);
Used to set whether or not the Hildon task navigator should be able to set the program to hibernation in case of low memory
self : |
The HildonProgram which can hibernate or not |
can_hibernate : |
whether or not the HildonProgram can hibernate |
gboolean hildon_program_get_can_hibernate (HildonProgram *self);
self : |
The HildonProgram which can hibernate or not |
| Returns : | Whether or not this HildonProgram is set to be support hibernation from the Hildon task navigator |
void hildon_program_set_common_menu (HildonProgram *self, GtkMenu *menu);
Sets a GtkMenu that will appear in all the HildonWindow registered
with the HildonProgram. Only one common GtkMenu can be set, further
calls will detach the previous common GtkMenu. A HildonWindow
can use it's own GtkMenu with hildon_window_set_menu()
This method does not support HildonAppMenu objects.
self : |
The HildonProgram in which the common menu should be used |
menu : |
A GtkMenu to use as common menu for the program |
GtkMenu* hildon_program_get_common_menu (HildonProgram *self);
self : |
The HildonProgram from which to retrieve the common menu |
| Returns : | the GtkMenu that was set as common menu for this
HildonProgram, or NULL of no common menu was set.
|
void hildon_program_set_common_toolbar (HildonProgram *self, GtkToolbar *toolbar);
Sets a GtkToolbar that will appear in all the HildonWindow registered
to the HildonProgram. 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_add_toolbar(). Both
HildonProgram and HildonWindow specific toolbars will be shown
self : |
The HildonProgram in which the common toolbar should be used |
toolbar : |
A GtkToolbar to use as common toolbar for the program |
GtkToolbar* hildon_program_get_common_toolbar (HildonProgram *self);
self : |
The HildonProgram from which to retrieve the common toolbar |
| Returns : | the GtkToolbar that was set as common toolbar for this
HildonProgram, or NULL of no common menu was set.
|
gboolean hildon_program_get_is_topmost (HildonProgram *self);
self : |
A HildonWindow |
| Returns : | Whether or not one of the program's window or dialog is currenltly activated by the window manager. |
HildonStackableWindow* hildon_program_pop_window_stack (HildonProgram *self);
The HildonProgram object maintains a list of stackable windows. Each time a HildonStackableWindow is shown, it is automatically added to the top of the stack. Windows are removed from the stack when they are hidden or destroyed.
This function is equivalent to calling gtk_widget_hide() on the
window on top of the stack. The window is hidden and removed from
the stack, but not destroyed.
self : |
A HildonProgram |
| Returns : | The HildonStackableWindow that was removed from the
stack, or NULL if the stack was empty.
|
HildonStackableWindow* hildon_program_peek_window_stack (HildonProgram *self);
The HildonProgram object maintains a list of stackable windows. Each time a HildonStackableWindow is shown, it is automatically added to the top of the stack. Windows are removed from the stack when they are destroyed.
This function returns the HildonStackableWindow from the top of
the stack, or NULL if the stack is empty. The stack is never modified.
self : |
A HildonProgram |
| Returns : | A HildonStackableWindow, or NULL.
|
void hildon_program_go_to_root_window (HildonProgram *self);
Will close all windows in the HildonProgram but the first one (the root window) by sending them a delete event. If any of the windows refuses to close (by capturing the event) no further events will be sent. Only windows of type HildonStackableWindow will be affected by this.
self : |
A HildonProgram |