HildonApp

HildonApp — A base widget to present application. Deprecated, use HildonProgram instead.

Synopsis




enum        HildonZoomLevel;
#define     HILDON_TYPE_ZOOM_LEVEL
#define     HILDON_MENU_KEY
#define     HILDON_HOME_KEY
#define     HILDON_TOOLBAR_KEY
#define     HILDON_FULLSCREEN_KEY
#define     HILDON_INCREASE_KEY
#define     HILDON_DECREASE_KEY
#define     HILDON_TOOLBAR_MODIFIERS
#define     HILDON_KEYEVENT_IS_MENU_KEY     (keyevent)
#define     HILDON_KEYEVENT_IS_HOME_KEY     (keyevent)
#define     HILDON_KEYEVENT_IS_TOOLBAR_KEY  (keyevent)
#define     HILDON_KEYEVENT_IS_FULLSCREEN_KEY(keyevent)
#define     HILDON_KEYEVENT_IS_INCREASE_KEY (keyevent)
#define     HILDON_KEYEVENT_IS_DECREASE_KEY (keyevent)
#define     TRANSIENCY_MAXITER
GType       hildon_app_get_type             (void);
GtkWidget*  hildon_app_new                  (void);
GtkWidget*  hildon_app_new_with_appview     (HildonAppView *appview);
void        hildon_app_set_appview          (HildonApp *self,
                                             HildonAppView *appview);
HildonAppView* hildon_app_get_appview       (HildonApp *self);
void        hildon_app_set_title            (HildonApp *self,
                                             const gchar *newtitle);
const gchar* hildon_app_get_title           (HildonApp *self);
void        hildon_app_set_zoom             (HildonApp *self,
                                             HildonZoomLevel newzoom);
HildonZoomLevel hildon_app_get_zoom         (HildonApp *self);
PangoFontDescription* hildon_app_get_default_font
                                            (HildonApp *self);
PangoFontDescription* hildon_app_get_zoom_font
                                            (HildonApp *self);
void        hildon_app_set_two_part_title   (HildonApp *self,
                                             gboolean istwoparttitle);
gboolean    hildon_app_get_two_part_title   (HildonApp *self);
void        hildon_app_set_autoregistration (HildonApp *self,
                                             gboolean auto_reg);
void        hildon_app_register_view        (HildonApp *self,
                                             gpointer view_ptr);
gboolean    hildon_app_register_view_with_id
                                            (HildonApp *self,
                                             gpointer view_ptr,
                                             unsigned long view_id);
void        hildon_app_unregister_view      (HildonApp *self,
                                             gpointer view_ptr);
void        hildon_app_unregister_view_with_id
                                            (HildonApp *self,
                                             unsigned long view_id);
unsigned long hildon_app_find_view_id       (HildonApp *self,
                                             gpointer view_ptr);
void        hildon_app_notify_view_changed  (HildonApp *self,
                                             gpointer view_ptr);
void        hildon_app_set_killable         (HildonApp *self,
                                             gboolean killability);
void        hildon_app_set_ui_manager       (HildonApp *self,
                                             GtkUIManager *uim);
GtkUIManager* hildon_app_get_ui_manager     (HildonApp *self);

Description

HildonApp is the base for any hildon application. It controls basic looks and functionality of an application, like a title.

This widget is deprecated use HildonProgram instead.


app = hildon_app_new_with_appview( appview );

hildon_app_set_title( app, "This is a hello dude application" );

Details

enum HildonZoomLevel

typedef enum /*< skip >*/
{
    HILDON_ZOOM_SMALL = 1,
    HILDON_ZOOM_MEDIUM = 2,
    HILDON_ZOOM_LARGE = 3
} HildonZoomLevel;

The Hildon zoom levels. Small meaning small font. Large meaning large font. These font are specified in the gtkrc files. This enum is deprecated and should not be used. It's just lecagy stuff from ancient specs.

`HILDON_ZOOM_SMALL`	Smallest font.
`HILDON_ZOOM_MEDIUM`	Middle size font.
`HILDON_ZOOM_LARGE`	Largest font.

HILDON_TYPE_ZOOM_LEVEL

#define HILDON_TYPE_ZOOM_LEVEL (hildon_zoom_level_get_type ())

HILDON_MENU_KEY

#define HILDON_MENU_KEY         GDK_F4

HILDON_HOME_KEY

#define HILDON_HOME_KEY         GDK_F5

HILDON_TOOLBAR_KEY

#define HILDON_TOOLBAR_KEY      GDK_T

HILDON_FULLSCREEN_KEY

#define HILDON_FULLSCREEN_KEY   GDK_F6

HILDON_INCREASE_KEY

#define HILDON_INCREASE_KEY     GDK_F7

HILDON_DECREASE_KEY

#define HILDON_DECREASE_KEY     GDK_F8

HILDON_TOOLBAR_MODIFIERS

#define HILDON_TOOLBAR_MODIFIERS (GDK_SHIFT_MASK | GDK_CONTROL_MASK)

HILDON_KEYEVENT_IS_MENU_KEY()

#define HILDON_KEYEVENT_IS_MENU_KEY(keyevent) (keyevent->keyval == HILDON_MENU_KEY)

keyevent :

HILDON_KEYEVENT_IS_HOME_KEY()

#define HILDON_KEYEVENT_IS_HOME_KEY(keyevent) (keyevent->keyval == HILDON_HOME_KEY)

keyevent :

HILDON_KEYEVENT_IS_TOOLBAR_KEY()

#define     HILDON_KEYEVENT_IS_TOOLBAR_KEY(keyevent)

keyevent :

HILDON_KEYEVENT_IS_FULLSCREEN_KEY()

#define HILDON_KEYEVENT_IS_FULLSCREEN_KEY(keyevent) (keyevent->keyval == HILDON_FULLSCREEN_KEY)

keyevent :

HILDON_KEYEVENT_IS_INCREASE_KEY()

#define HILDON_KEYEVENT_IS_INCREASE_KEY(keyevent) (keyevent->keyval == HILDON_INCREASE_KEY)

keyevent :

HILDON_KEYEVENT_IS_DECREASE_KEY()

#define HILDON_KEYEVENT_IS_DECREASE_KEY(keyevent) (keyevent->keyval == HILDON_DECREASE_KEY)

keyevent :

TRANSIENCY_MAXITER

#define TRANSIENCY_MAXITER 50

hildon_app_get_type ()

GType       hildon_app_get_type             (void);

Returns :

hildon_app_new ()

GtkWidget*  hildon_app_new                  (void);

Creates a new HildonApp

Returns :

pointer to a new HildonApp structure

hildon_app_new_with_appview ()

GtkWidget*  hildon_app_new_with_appview     (HildonAppView *appview);

Creates an app, and sets it's initial appview.

`appview` :	a HildonAppView
Returns :	pointer to a new HildonApp structure

hildon_app_set_appview ()

void        hildon_app_set_appview          (HildonApp *self,
                                             HildonAppView *appview);

Sets (switches to) appview.

`self` :	a HildonApp
`appview` :	a HildonAppView

hildon_app_get_appview ()

HildonAppView* hildon_app_get_appview       (HildonApp *self);

Gets the currently shown appview.

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

`self` :	a HildonApp
Returns :	NULL.

hildon_app_set_title ()

void        hildon_app_set_title            (HildonApp *self,
                                             const gchar *newtitle);

Sets title of the application.

`self` :	a HildonApp
`newtitle` :	the new title assigned to the application

hildon_app_get_title ()

const gchar* hildon_app_get_title           (HildonApp *self);

Gets the title of the application.

`self` :	a HildonApp
Returns :	the title currently assigned to the application. This value is not to be freed or modified by the calling application

hildon_app_set_zoom ()

void        hildon_app_set_zoom             (HildonApp *self,
                                             HildonZoomLevel newzoom);

Sets the zoom level. Warning! This function is deprecated and should not be used. It's lecacy stuff from ancient specs.

`self` :	a HildonApp
`newzoom` :	the zoom level of type HildonZoomLevel to be assigned to an application

hildon_app_get_zoom ()

HildonZoomLevel hildon_app_get_zoom         (HildonApp *self);

Gets the zoom level. Warning! This function is deprecated and should not be used. It's lecacy stuff from ancient specifications.

`self` :	a HildonApp
Returns :	the zoom level of the Hildon application. The returned zoom level is of type HildonZoomLevel.

hildon_app_get_default_font ()

PangoFontDescription* hildon_app_get_default_font
                                            (HildonApp *self);

Gets default font. Warning! This function is deprecated and should not be used. It's legacy stuff from ancient version of specification.

`self` :	a HildonApp
Returns :	pointer to PangoFontDescription for the default, normal size font

hildon_app_get_zoom_font ()

PangoFontDescription* hildon_app_get_zoom_font
                                            (HildonApp *self);

Gets the description of the default font. Warning! This function is deprecated and should not be used. It's legacy stuff from ancient specs.

`self` :	a HildonApp
Returns :	pointer to PangoFontDescription for the default, normal size font

hildon_app_set_two_part_title ()

void        hildon_app_set_two_part_title   (HildonApp *self,
                                             gboolean istwoparttitle);

Sets the two part title.

`self` :	a HildonApp
`istwoparttitle` :	a gboolean indicating wheter to activate a title that has both the application title and application view title separated by a triangle

hildon_app_get_two_part_title ()

gboolean    hildon_app_get_two_part_title   (HildonApp *self);

Gets the 'twopart' represention of the title inside HildonApp.

`self` :	a HildonApp
Returns :	a boolean indicating wheter title shown has both application, and application view title separated by a triangle.

hildon_app_set_autoregistration ()

void        hildon_app_set_autoregistration (HildonApp *self,
                                             gboolean auto_reg);

Controls the autoregistration/unregistration of (app)views.

`self` :	a HildonApp
`auto_reg` :	whether the (app)view autoregistration should be active

hildon_app_register_view ()

void        hildon_app_register_view        (HildonApp *self,
                                             gpointer view_ptr);

Registers a new view. For appviews, this can be done automatically if autoregistration is set.

`self` :	a HildonApp
`view_ptr` :	pointer to the view instance to be registered

hildon_app_register_view_with_id ()

gboolean    hildon_app_register_view_with_id
                                            (HildonApp *self,
                                             gpointer view_ptr,
                                             unsigned long view_id);

Registers a new view. Allows the application to specify any ID.

`self` :	a HildonApp
`view_ptr` :	pointer to the view instance to be registered
`Param3` :
Returns :	TRUE if the view registration succeeded, FALSE otherwise. The probable cause of failure is that view with that ID already existed.

hildon_app_unregister_view ()

void        hildon_app_unregister_view      (HildonApp *self,
                                             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.

`self` :	a HildonApp
`view_ptr` :	pointer to the view instance to be unregistered

hildon_app_unregister_view_with_id ()

void        hildon_app_unregister_view_with_id
                                            (HildonApp *self,
                                             unsigned long view_id);

Unregisters a view with specified ID, if it exists.

`self` :	a HildonApp
`Param2` :

hildon_app_find_view_id ()

unsigned long hildon_app_find_view_id       (HildonApp *self,
                                             gpointer view_ptr);

`self` :	a HildonApp
`view_ptr` :	pointer to the view whose ID we want to acquire
Returns :	the ID of the view, or 0 if not found Allows mapping of view pointer to its view ID. If NULL is passed as the view pointer, returns the ID of the current view.

hildon_app_notify_view_changed ()

void        hildon_app_notify_view_changed  (HildonApp *self,
                                             gpointer view_ptr);

Updates the X property that contains the currently active view

`self` :	a HildonApp
`view_ptr` :	pointer to the view that is switched to

hildon_app_set_killable ()

void        hildon_app_set_killable         (HildonApp *self,
                                             gboolean killability);

Updates information about whether the application can be killed or not by Task Navigator (i.e. whether its statesave is up to date)

`self` :	a HildonApp
`killability` :	truth value indicating whether the app can be killed

hildon_app_set_ui_manager ()

void        hildon_app_set_ui_manager       (HildonApp *self,
                                             GtkUIManager *uim);

Sets the GtkUIManager assigned to the HildonApp. If uim is NULL, unsets the current ui manager. The HildonApp holds a reference to the ui manager until the HildonApp is destroyed or unset.

`self` :	HildonApp
`uim` :	GtkUIManager to be set

hildon_app_get_ui_manager ()

GtkUIManager* hildon_app_get_ui_manager     (HildonApp *self);

Gets the GtkUIManager assigned to the HildonApp.

`self` :	HildonApp
Returns :	the GtkUIManager assigned to this application or null if no manager is assigned

HildonApp

Synopsis

Description

Details

enum HildonZoomLevel

HILDON_TYPE_ZOOM_LEVEL

HILDON_MENU_KEY

HILDON_HOME_KEY

HILDON_TOOLBAR_KEY

HILDON_FULLSCREEN_KEY

HILDON_INCREASE_KEY

HILDON_DECREASE_KEY

HILDON_TOOLBAR_MODIFIERS

HILDON_KEYEVENT_IS_MENU_KEY()

HILDON_KEYEVENT_IS_HOME_KEY()

HILDON_KEYEVENT_IS_TOOLBAR_KEY()

HILDON_KEYEVENT_IS_FULLSCREEN_KEY()

HILDON_KEYEVENT_IS_INCREASE_KEY()

HILDON_KEYEVENT_IS_DECREASE_KEY()

TRANSIENCY_MAXITER

hildon_app_get_type ()

hildon_app_new ()

hildon_app_new_with_appview ()

hildon_app_set_appview ()

hildon_app_get_appview ()

hildon_app_set_title ()

hildon_app_get_title ()

hildon_app_set_zoom ()

hildon_app_get_zoom ()

hildon_app_get_default_font ()

hildon_app_get_zoom_font ()

hildon_app_set_two_part_title ()

hildon_app_get_two_part_title ()

hildon_app_set_autoregistration ()

hildon_app_register_view ()

hildon_app_register_view_with_id ()

hildon_app_unregister_view ()

hildon_app_unregister_view_with_id ()

hildon_app_find_view_id ()

hildon_app_notify_view_changed ()

hildon_app_set_killable ()

hildon_app_set_ui_manager ()

hildon_app_get_ui_manager ()

See Also