CinnamonAppSystem

CinnamonAppSystem

Synopsis

struct              CinnamonAppSystem;
struct              CinnamonAppSystemClass;
CinnamonAppSystem * cinnamon_app_system_get_default     (void);
GMenuTree *         cinnamon_app_system_get_tree        (CinnamonAppSystem *system);
CinnamonApp *       cinnamon_app_system_lookup_app      (CinnamonAppSystem *system,
                                                         const char *id);
CinnamonApp *       cinnamon_app_system_lookup_settings_app
                                                        (CinnamonAppSystem *system,
                                                         const char *id);
CinnamonApp *       cinnamon_app_system_lookup_app_by_tree_entry
                                                        (CinnamonAppSystem *system,
                                                         GMenuTreeEntry *entry);
CinnamonApp *       cinnamon_app_system_lookup_settings_app_by_tree_entry
                                                        (CinnamonAppSystem *system,
                                                         GMenuTreeEntry *entry);
CinnamonApp *       cinnamon_app_system_lookup_app_for_path
                                                        (CinnamonAppSystem *system,
                                                         const char *desktop_path);
CinnamonApp *       cinnamon_app_system_lookup_heuristic_basename
                                                        (CinnamonAppSystem *system,
                                                         const char *id);
CinnamonApp *       cinnamon_app_system_lookup_startup_wmclass
                                                        (CinnamonAppSystem *system,
                                                         const char *wmclass);
CinnamonApp *       cinnamon_app_system_lookup_desktop_wmclass
                                                        (CinnamonAppSystem *system,
                                                         const char *wmclass);
GSList *            cinnamon_app_system_get_all         (CinnamonAppSystem *system);
GSList *            cinnamon_app_system_get_running     (CinnamonAppSystem *self);
GSList *            cinnamon_app_system_initial_search  (CinnamonAppSystem *system,
                                                         GSList *terms);
GSList *            cinnamon_app_system_subsearch       (CinnamonAppSystem *system,
                                                         GSList *previous_results,
                                                         GSList *terms);
GMenuTree *         cinnamon_app_system_get_settings_tree
                                                        (CinnamonAppSystem *system);
GSList *            cinnamon_app_system_search_settings (CinnamonAppSystem *system,
                                                         GSList *terms);
CinnamonApp *       cinnamon_app_system_lookup_setting  (CinnamonAppSystem *system,
                                                         const char *id);

Object Hierarchy

  GObject
   +----CinnamonAppSystem

Signals

  "app-state-changed"                              : Run Last
  "installed-changed"                              : Run Last

Description

Details

struct CinnamonAppSystem

struct CinnamonAppSystem;

struct CinnamonAppSystemClass

struct CinnamonAppSystemClass {
  GObjectClass parent_class;

  void (*installed_changed)(CinnamonAppSystem *appsys, gpointer user_data);
  void (*favorites_changed)(CinnamonAppSystem *appsys, gpointer user_data);
};

cinnamon_app_system_get_default ()

CinnamonAppSystem * cinnamon_app_system_get_default     (void);

Returns :

 The global CinnamonAppSystem singleton. [transfer none]

cinnamon_app_system_get_tree ()

GMenuTree *         cinnamon_app_system_get_tree        (CinnamonAppSystem *system);

Returns :

 The GMenuTree for apps. [transfer none]

cinnamon_app_system_lookup_app ()

CinnamonApp *       cinnamon_app_system_lookup_app      (CinnamonAppSystem *system,
                                                         const char *id);

Find a CinnamonApp corresponding to an id.

Returns :

 The CinnamonApp for id, or NULL if none. [transfer none]

cinnamon_app_system_lookup_settings_app ()

CinnamonApp *       cinnamon_app_system_lookup_settings_app
                                                        (CinnamonAppSystem *system,
                                                         const char *id);

Returns :

 The CinnamonApp for id, or NULL if none OBSOLETE - ONLY LEFT IN FOR COMPATIBILITY RETURNS NULL. [transfer none]

cinnamon_app_system_lookup_app_by_tree_entry ()

CinnamonApp *       cinnamon_app_system_lookup_app_by_tree_entry
                                                        (CinnamonAppSystem *system,
                                                         GMenuTreeEntry *entry);

Find a CinnamonApp corresponding to a GMenuTreeEntry.

system :

 a CinnamonAppSystem

entry :

 a GMenuTreeEntry

Returns :

 The CinnamonApp for entry, or NULL if none. [transfer none]

cinnamon_app_system_lookup_settings_app_by_tree_entry ()

CinnamonApp *       cinnamon_app_system_lookup_settings_app_by_tree_entry
                                                        (CinnamonAppSystem *system,
                                                         GMenuTreeEntry *entry);

Returns :

 The CinnamonApp for entry, or NULL if none OBSOLETE - ONLY LEFT IN FOR COMPATIBILITY RETURNS NULL. [transfer none]

cinnamon_app_system_lookup_app_for_path ()

CinnamonApp *       cinnamon_app_system_lookup_app_for_path
                                                        (CinnamonAppSystem *system,
                                                         const char *desktop_path);

Find or create a CinnamonApp corresponding to a given absolute file name which must be in the standard paths (XDG_DATA_DIRS). For files outside the datadirs, this function returns NULL.

system :

 a CinnamonAppSystem

desktop_path :

 UTF-8 encoded absolute file name. [type utf8]

Returns :

 The CinnamonApp for id, or NULL if none. [transfer none]

cinnamon_app_system_lookup_heuristic_basename ()

CinnamonApp *       cinnamon_app_system_lookup_heuristic_basename
                                                        (CinnamonAppSystem *system,
                                                         const char *id);

Find a valid application corresponding to a given heuristically determined application identifier string, or NULL if none.

system :

 a CinnamonAppSystem

id :

 Probable application identifier

Returns :

 A CinnamonApp for name. [transfer none]

cinnamon_app_system_lookup_startup_wmclass ()

CinnamonApp *       cinnamon_app_system_lookup_startup_wmclass
                                                        (CinnamonAppSystem *system,
                                                         const char *wmclass);

Find a valid application whose .desktop file contains a StartupWMClass entry matching wmclass.

system :

 a CinnamonAppSystem

wmclass :

 A WM_CLASS value. [allow-none]

Returns :

 A CinnamonApp for wmclass. [transfer none]

cinnamon_app_system_lookup_desktop_wmclass ()

CinnamonApp *       cinnamon_app_system_lookup_desktop_wmclass
                                                        (CinnamonAppSystem *system,
                                                         const char *wmclass);

Find a valid application whose .desktop file, without the extension and properly canonicalized, matches wmclass.

system :

 a CinnamonAppSystem

wmclass :

 A WM_CLASS value. [allow-none]

Returns :

 A CinnamonApp for wmclass. [transfer none]

cinnamon_app_system_get_all ()

GSList *            cinnamon_app_system_get_all         (CinnamonAppSystem *system);

Returns :

 All installed applications. [transfer container][element-type CinnamonApp]

cinnamon_app_system_get_running ()

GSList *            cinnamon_app_system_get_running     (CinnamonAppSystem *self);

Returns the set of applications which currently have at least one open window in the given context. The returned list will be sorted by cinnamon_app_compare().

self :

 A CinnamonAppSystem

Returns :

 Active applications. [element-type CinnamonApp][transfer container]

cinnamon_app_system_initial_search ()

GSList *            cinnamon_app_system_initial_search  (CinnamonAppSystem *system,
                                                         GSList *terms);

Search through applications for the given search terms.

system :

 A CinnamonAppSystem

terms :

 List of terms, logical AND. [element-type utf8]

Returns :

 List of applications. [transfer container][element-type CinnamonApp]

cinnamon_app_system_subsearch ()

GSList *            cinnamon_app_system_subsearch       (CinnamonAppSystem *system,
                                                         GSList *previous_results,
                                                         GSList *terms);

Search through a previous result set; for more information, see js/ui/search.js. Note the value of prefs must be the same as passed to cinnamon_app_system_initial_search(). Note that returned strings are only valid until a return to the main loop.

system :

 A CinnamonAppSystem

previous_results :

 List of previous results. [element-type CinnamonApp]

terms :

 List of terms, logical AND. [element-type utf8]

Returns :

 List of application identifiers. [transfer container][element-type CinnamonApp]

cinnamon_app_system_get_settings_tree ()

GMenuTree *         cinnamon_app_system_get_settings_tree
                                                        (CinnamonAppSystem *system);

Returns :

 The GMenuTree for apps OBSOLETE - ONLY LEFT IN FOR COMPATIBILITY RETURNS EMPTY GMenuTree. [transfer none]

cinnamon_app_system_search_settings ()

GSList *            cinnamon_app_system_search_settings (CinnamonAppSystem *system,
                                                         GSList *terms);

Search through settings for the given search terms.

system :

 A CinnamonAppSystem

terms :

 List of terms, logical AND. [element-type utf8]

Returns :

 List of setting applications. [transfer container][element-type CinnamonApp]

cinnamon_app_system_lookup_setting ()

CinnamonApp *       cinnamon_app_system_lookup_setting  (CinnamonAppSystem *system,
                                                         const char *id);

Returns :

 Application in gnomecc.menu, or NULL if none OBSOLETE - ONLY LEFT IN FOR COMPATIBILITY RETURNS NULL IF NOT FOUND IN STANDARD APPS. [transfer none]

Signal Details

The "app-state-changed" signal

void                user_function                      (CinnamonAppSystem *cinnamonappsystem,
                                                        CinnamonApp       *arg1,
                                                        gpointer           user_data)              : Run Last

The "installed-changed" signal

void                user_function                      (CinnamonAppSystem *cinnamonappsystem,
                                                        gpointer           user_data)              : Run Last
Generated by GTK-Doc V1.19