EomApplication

EomApplication

Synopsis

#define             EOM_APP
struct              EomApplication;
EomApplication *    eom_application_get_instance        (void);
gboolean            eom_application_register_service    (EomApplication *application);
void                eom_application_shutdown            (EomApplication *application);
gboolean            eom_application_open_window         (EomApplication *application,
                                                         guint timestamp,
                                                         EomStartupFlags flags,
                                                         GError **error);
gboolean            eom_application_open_uri_list       (EomApplication *application,
                                                         GSList *uri_list,
                                                         guint timestamp,
                                                         EomStartupFlags flags,
                                                         GError **error);
gboolean            eom_application_open_file_list      (EomApplication *application,
                                                         GSList *file_list,
                                                         guint timestamp,
                                                         EomStartupFlags flags,
                                                         GError **error);
gboolean            eom_application_open_uris           (EomApplication *application,
                                                         gchar **uris,
                                                         guint timestamp,
                                                         EomStartupFlags flags,
                                                         GError **error);
GList *             eom_application_get_windows         (EomApplication *application);
EggToolbarsModel *  eom_application_get_toolbars_model  (EomApplication *application);
void                eom_application_save_toolbars_model (EomApplication *application);
void                eom_application_reset_toolbars_model
                                                        (EomApplication *app);
void                eom_application_screensaver_enable  (EomApplication *application);
void                eom_application_screensaver_disable (EomApplication *application);

Object Hierarchy

  GObject
   +----EomApplication

Description

Details

EOM_APP

#define EOM_APP				(eom_application_get_instance ())


struct EomApplication

struct EomApplication;


eom_application_get_instance ()

EomApplication *    eom_application_get_instance        (void);

Returns a singleton instance of EomApplication currently running. If not running yet, it will create one.

Returns :

a running EomApplication.

eom_application_register_service ()

gboolean            eom_application_register_service    (EomApplication *application);

Registers EomApplication's DBus service, to allow remote calls. If the DBus service is already registered, or there is any other connection error, returns FALSE.

application :

An EomApplication.

Returns :

TRUE if the service was registered succesfully. FALSE otherwise.

eom_application_shutdown ()

void                eom_application_shutdown            (EomApplication *application);

Takes care of shutting down the Eye of MATE, and quits.

application :

An EomApplication.

eom_application_open_window ()

gboolean            eom_application_open_window         (EomApplication *application,
                                                         guint timestamp,
                                                         EomStartupFlags flags,
                                                         GError **error);

Opens and presents an empty EomWindow to the user. If there is an empty window already open, this will be used. Otherwise, a new one will be instantiated.

application :

An EomApplication.

timestamp :

The timestamp of the user interaction which triggered this call (see gtk_window_present_with_time()).

flags :

A set of EomStartupFlags influencing a new windows' state.

error :

Return location for a GError, or NULL to ignore errors.

Returns :

FALSE if application is invalid, TRUE otherwise

eom_application_open_uri_list ()

gboolean            eom_application_open_uri_list       (EomApplication *application,
                                                         GSList *uri_list,
                                                         guint timestamp,
                                                         EomStartupFlags flags,
                                                         GError **error);

Opens a list of images, from a list of URIs. See eom_application_open_file_list() for details.

application :

An EomApplication.

uri_list :

A list of URIs.

timestamp :

The timestamp of the user interaction which triggered this call (see gtk_window_present_with_time()).

flags :

A set of EomStartupFlags influencing a new windows' state.

error :

Return location for a GError, or NULL to ignore errors.

Returns :

Currently always TRUE.

eom_application_open_file_list ()

gboolean            eom_application_open_file_list      (EomApplication *application,
                                                         GSList *file_list,
                                                         guint timestamp,
                                                         EomStartupFlags flags,
                                                         GError **error);

Opens a list of files in a EomWindow. If an EomWindow displaying the first image in the list is already open, this will be used. Otherwise, an empty EomWindow is used, either already existing or newly created.

application :

An EomApplication.

file_list :

A list of GFiles.

timestamp :

The timestamp of the user interaction which triggered this call (see gtk_window_present_with_time()).

flags :

A set of EomStartupFlags influencing a new windows' state.

error :

Return location for a GError, or NULL to ignore errors.

Returns :

Currently always TRUE.

eom_application_open_uris ()

gboolean            eom_application_open_uris           (EomApplication *application,
                                                         gchar **uris,
                                                         guint timestamp,
                                                         EomStartupFlags flags,
                                                         GError **error);

Opens a list of images, from a list of URI strings. See eom_application_open_file_list() for details.

application :

an EomApplication

uris :

A GList of URI strings.

timestamp :

The timestamp of the user interaction which triggered this call (see gtk_window_present_with_time()).

flags :

A set of EomStartupFlags influencing a new windows' state.

error :

Return location for a GError, or NULL to ignore errors.

Returns :

Currently always TRUE.

eom_application_get_windows ()

GList *             eom_application_get_windows         (EomApplication *application);

Gets the list of existing EomApplications. The windows in this list are not individually referenced, you need to keep your own references if you want to perform actions that may destroy them.

application :

An EomApplication.

Returns :

A new list of EomWindows.

eom_application_get_toolbars_model ()

EggToolbarsModel *  eom_application_get_toolbars_model  (EomApplication *application);

Retrieves the EggToolbarsModel for the toolbar in EomApplication.

application :

An EomApplication.

Returns :

An EggToolbarsModel.

eom_application_save_toolbars_model ()

void                eom_application_save_toolbars_model (EomApplication *application);

Causes the saving of the model of the toolbar in EomApplication to a file.

application :

An EomApplication.

eom_application_reset_toolbars_model ()

void                eom_application_reset_toolbars_model
                                                        (EomApplication *app);

Restores the toolbars model to the defaults.

app :

an EomApplication

eom_application_screensaver_enable ()

void                eom_application_screensaver_enable  (EomApplication *application);

Enables the screensaver. Usually necessary after a call to eom_application_screensaver_disable().

application :

an EomApplication.

eom_application_screensaver_disable ()

void                eom_application_screensaver_disable (EomApplication *application);

Disables the screensaver. Useful when the application is in fullscreen or similar mode.

application :

an EomApplication.