LauncherApplication

LauncherApplication — Abstract representation of an application

Synopsis

#include <launcher-application.h>

                    LauncherApplicationWindow;
void                (*LauncherApplicationWindowActivateFunc)
                                                        (WnckWindow *window,
                                                         guint32 timestamp,
                                                         void *callback_d);
                    LauncherApplication;
LauncherApplication * launcher_application_new          (void);
LauncherApplication * launcher_application_new_from_desktop_file
                                                        (const gchar *desktop_file,
                                                         gboolean dont_check_windows);
LauncherApplication * launcher_application_new_from_wnck_window
                                                        (WnckWindow *window);
gboolean            launcher_application_launch         (LauncherApplication *application,
                                                         GError **error);
const gchar *       launcher_application_get_unique_string
                                                        (LauncherApplication *application);
GSList *            launcher_application_get_windows    (LauncherApplication *application);
gboolean            launcher_application_owns_window    (LauncherApplication *application,
                                                         WnckWindow *window);
void                launcher_application_update_windows (LauncherApplication *application);
void                launcher_application_ensure_state   (LauncherApplication *application);
const gchar *       launcher_application_get_name       (LauncherApplication *application);
const gchar *       launcher_application_get_comment    (LauncherApplication *application);
const gchar *       launcher_application_get_icon_name  (LauncherApplication *application);
const gchar *       launcher_application_get_exec_string
                                                        (LauncherApplication *application);
const gchar *       launcher_application_get_desktop_file
                                                        (LauncherApplication *application);
void                launcher_application_set_desktop_file
                                                        (LauncherApplication *application,
                                                         const gchar *desktop_file,
                                                         gboolean dont_check_windows);
gboolean            launcher_application_get_urgent     (LauncherApplication *application);
gboolean            launcher_application_get_running    (LauncherApplication *application);
gboolean            launcher_application_get_favorite   (LauncherApplication *application);
gboolean            launcher_application_get_focused    (LauncherApplication *application);
void                launcher_application_show           (LauncherApplication *application,
                                                         guint32 timestamp);
void                launcher_application_minimize       (LauncherApplication *application);
gboolean            launcher_application_has_minimized  (LauncherApplication *application);
void                launcher_application_restore        (LauncherApplication *application,
                                                         guint32 timestamp);
void                launcher_application_close          (LauncherApplication *application,
                                                         guint32 timestamp);
void                launcher_application_set_window_activate_func
                                                        (LauncherApplicationWindowActivateFunc func,
                                                         void *callback_d);
gboolean            launcher_application_has_gathered_windows
                                                        (LauncherApplication *application);

Description

LauncherApplication objects exist in order to acquire data about specific applications and to launch applications. it also provides a method for returning a libwnck application

Details

LauncherApplicationWindow

typedef struct _LauncherApplicationWindow LauncherApplicationWindow;


LauncherApplicationWindowActivateFunc ()

void                (*LauncherApplicationWindowActivateFunc)
                                                        (WnckWindow *window,
                                                         guint32 timestamp,
                                                         void *callback_d);

window :

timestamp :

callback_d :


LauncherApplication

typedef struct {
  GObject parent_instance;

  /* Private */
  LauncherApplicationPrivate *priv;
} LauncherApplication;


launcher_application_new ()

LauncherApplication * launcher_application_new          (void);

Returns :


launcher_application_new_from_desktop_file ()

LauncherApplication * launcher_application_new_from_desktop_file
                                                        (const gchar *desktop_file,
                                                         gboolean dont_check_windows);

desktop_file :

dont_check_windows :

Returns :


launcher_application_new_from_wnck_window ()

LauncherApplication * launcher_application_new_from_wnck_window
                                                        (WnckWindow *window);

creates a new LauncherApplication object based on information from window

window :

A WnckWindow object

Returns :


launcher_application_launch ()

gboolean            launcher_application_launch         (LauncherApplication *application,
                                                         GError **error);

This method will attempt to launch the application using the exec string associated with it

application :

a LauncherApplication object

error :

a GError error

Returns :

A truth value dictating whether the launching was successful

launcher_application_get_unique_string ()

const gchar *       launcher_application_get_unique_string
                                                        (LauncherApplication *application);

Provides a unique string that can be used to identify this application

application :

Returns :

a unique string

launcher_application_get_windows ()

GSList *            launcher_application_get_windows    (LauncherApplication *application);

Provides a list of WnckApplications associated with this app

application :

Returns :

a GSList containing WnckApplications. transfer none.

launcher_application_owns_window ()

gboolean            launcher_application_owns_window    (LauncherApplication *application,
                                                         WnckWindow *window);

application :

window :

Returns :


launcher_application_update_windows ()

void                launcher_application_update_windows (LauncherApplication *application);

application :


launcher_application_ensure_state ()

void                launcher_application_ensure_state   (LauncherApplication *application);

application :


launcher_application_get_name ()

const gchar *       launcher_application_get_name       (LauncherApplication *application);

Get the internationalized name of the application. Suitable for display.

application :

a LauncherApplication object

Returns :

a string containing the name

launcher_application_get_comment ()

const gchar *       launcher_application_get_comment    (LauncherApplication *application);

Get the internationalized comment string assigned to this application. Suitable for display as a short description of the application.

application :

A LauncherApplication object

Returns :

An internationalized string containing the comment

launcher_application_get_icon_name ()

const gchar *       launcher_application_get_icon_name  (LauncherApplication *application);

Get icon-name associated with the application

application :

A LauncherApplication object

Returns :

an icon-name string

launcher_application_get_exec_string ()

const gchar *       launcher_application_get_exec_string
                                                        (LauncherApplication *application);

Get the command line used to start this application

application :

A LauncherApplication

Returns :

the command line used to start this application

launcher_application_get_desktop_file ()

const gchar *       launcher_application_get_desktop_file
                                                        (LauncherApplication *application);

Get the absolute path to the .desktop file for this application

application :

A LauncherApplication

Returns :

the path to the .desktop file

launcher_application_set_desktop_file ()

void                launcher_application_set_desktop_file
                                                        (LauncherApplication *application,
                                                         const gchar *desktop_file,
                                                         gboolean dont_check_windows);

sets the desktop file for this application and will also regenerate its information

application :

A LauncherApplication

desktop_file :

A string describing the path to a desktop file

dont_check_windows :


launcher_application_get_urgent ()

gboolean            launcher_application_get_urgent     (LauncherApplication *application);

application :

Returns :


launcher_application_get_running ()

gboolean            launcher_application_get_running    (LauncherApplication *application);

Method to tell if the application is currently running or not

application :

A LauncherApplication

Returns :

A Truth value

launcher_application_get_favorite ()

gboolean            launcher_application_get_favorite   (LauncherApplication *application);

Method to tell if the application is a favorite or not

application :

A LauncherApplication

Returns :

A Truth value

launcher_application_get_focused ()

gboolean            launcher_application_get_focused    (LauncherApplication *application);

provides a method that will return true if any of this applicaiton's windows are currently "focused"

application :

A LauncherApplication

Returns :

a gboolean value

launcher_application_show ()

void                launcher_application_show           (LauncherApplication *application,
                                                         guint32 timestamp);

this method will focus the latest un-minimized window this application has all this application's windows are minimized then this method will unminimize them all

application :

a LauncherApplication

timestamp :


launcher_application_minimize ()

void                launcher_application_minimize       (LauncherApplication *application);

application :


launcher_application_has_minimized ()

gboolean            launcher_application_has_minimized  (LauncherApplication *application);

application :

Returns :


launcher_application_restore ()

void                launcher_application_restore        (LauncherApplication *application,
                                                         guint32 timestamp);

application :

timestamp :


launcher_application_close ()

void                launcher_application_close          (LauncherApplication *application,
                                                         guint32 timestamp);

application :

timestamp :


launcher_application_set_window_activate_func ()

void                launcher_application_set_window_activate_func
                                                        (LauncherApplicationWindowActivateFunc func,
                                                         void *callback_d);

Allows external control of showing windows

func :

a LauncherApplicationWindowActivateFunc handler

callback_d :


launcher_application_has_gathered_windows ()

gboolean            launcher_application_has_gathered_windows
                                                        (LauncherApplication *application);

application :

Returns :