PlankItemsApplicationDockItem

PlankItemsApplicationDockItem — A dock item for applications (with .desktop launchers).

Synopsis

#define             PLANK_ITEMS_TYPE_APPLICATION_DOCK_ITEM
gboolean            plank_items_application_dock_item_is_running
                                                        (PlankItemsApplicationDockItem *self);
gboolean            plank_items_application_dock_item_is_window
                                                        (PlankItemsApplicationDockItem *self);
void                plank_items_application_dock_item_set_urgent
                                                        (PlankItemsApplicationDockItem *self,
                                                         gboolean is_urgent);
void                plank_items_application_dock_item_load_from_launcher
                                                        (PlankItemsApplicationDockItem *self);
gchar *             plank_items_application_dock_item_get_unity_application_uri
                                                        (PlankItemsApplicationDockItem *self);
gchar *             plank_items_application_dock_item_get_unity_dbusname
                                                        (PlankItemsApplicationDockItem *self);
void                plank_items_application_dock_item_unity_update
                                                        (PlankItemsApplicationDockItem *self,
                                                         const gchar *sender_name,
                                                         GVariantIter *prop_iter);
void                plank_items_application_dock_item_unity_reset
                                                        (PlankItemsApplicationDockItem *self);
PlankItemsApplicationDockItem * plank_items_application_dock_item_new_with_dockitem_file
                                                        (GFile *file);
PlankItemsApplicationDockItem * plank_items_application_dock_item_new_with_dockitem_filename
                                                        (const gchar *filename);
PlankItemsApplicationDockItem * plank_items_application_dock_item_new
                                                        (void);
void                plank_items_application_dock_item_parse_launcher
                                                        (const gchar *launcher,
                                                         gchar **icon,
                                                         gchar **text,
                                                         GeeArrayList *actions,
                                                         GeeMap *actions_map,
                                                         GeeArrayList *mimes);
struct              PlankItemsApplicationDockItem;
struct              PlankItemsApplicationDockItemClass;

Object Hierarchy

  GObject
   +----PlankItemsDockItem
         +----PlankItemsApplicationDockItem
               +----PlankItemsPlankDockItem
               +----PlankItemsTransientDockItem

Properties

  "App"                      BamfApplication*      : Read / Write / Construct

Signals

  "app-closed"                                     : Run Last
  "app-window-added"                               : Run Last
  "app-window-removed"                             : Run Last
  "pin-launcher"                                   : Run Last

Description

Details

PLANK_ITEMS_TYPE_APPLICATION_DOCK_ITEM

#define PLANK_ITEMS_TYPE_APPLICATION_DOCK_ITEM (plank_items_application_dock_item_get_type ())

The type for PlankItemsApplicationDockItem.


plank_items_application_dock_item_is_running ()

gboolean            plank_items_application_dock_item_is_running
                                                        (PlankItemsApplicationDockItem *self);

self :

the PlankItemsApplicationDockItem instance

plank_items_application_dock_item_is_window ()

gboolean            plank_items_application_dock_item_is_window
                                                        (PlankItemsApplicationDockItem *self);

self :

the PlankItemsApplicationDockItem instance

plank_items_application_dock_item_set_urgent ()

void                plank_items_application_dock_item_set_urgent
                                                        (PlankItemsApplicationDockItem *self,
                                                         gboolean is_urgent);

self :

the PlankItemsApplicationDockItem instance

is_urgent :

 

plank_items_application_dock_item_load_from_launcher ()

void                plank_items_application_dock_item_load_from_launcher
                                                        (PlankItemsApplicationDockItem *self);

Parses the associated launcher and sets the icon and text from it.

self :

the PlankItemsApplicationDockItem instance

plank_items_application_dock_item_get_unity_application_uri ()

gchar *             plank_items_application_dock_item_get_unity_application_uri
                                                        (PlankItemsApplicationDockItem *self);

Get libunity application URI

self :

the PlankItemsApplicationDockItem instance

Returns :

the libunity application uri of this item, or NULL

plank_items_application_dock_item_get_unity_dbusname ()

gchar *             plank_items_application_dock_item_get_unity_dbusname
                                                        (PlankItemsApplicationDockItem *self);

Get current libunity dbusname

self :

the PlankItemsApplicationDockItem instance

Returns :

the dbusname which provides the LauncherEntry interface, or NULL

plank_items_application_dock_item_unity_update ()

void                plank_items_application_dock_item_unity_update
                                                        (PlankItemsApplicationDockItem *self,
                                                         const gchar *sender_name,
                                                         GVariantIter *prop_iter);

Update this item's remote libunity value based on the given data

self :

the PlankItemsApplicationDockItem instance

sender_name :

 . the corressponding dbusname. [in]

prop_iter :

 . the data in a standardize format from libunity. [in]

plank_items_application_dock_item_unity_reset ()

void                plank_items_application_dock_item_unity_reset
                                                        (PlankItemsApplicationDockItem *self);

Reset this item's remote libunity values

self :

the PlankItemsApplicationDockItem instance

plank_items_application_dock_item_new_with_dockitem_file ()

PlankItemsApplicationDockItem * plank_items_application_dock_item_new_with_dockitem_file
                                                        (GFile *file);

file :

 

plank_items_application_dock_item_new_with_dockitem_filename ()

PlankItemsApplicationDockItem * plank_items_application_dock_item_new_with_dockitem_filename
                                                        (const gchar *filename);

filename :

 

plank_items_application_dock_item_new ()

PlankItemsApplicationDockItem * plank_items_application_dock_item_new
                                                        (void);

plank_items_application_dock_item_parse_launcher ()

void                plank_items_application_dock_item_parse_launcher
                                                        (const gchar *launcher,
                                                         gchar **icon,
                                                         gchar **text,
                                                         GeeArrayList *actions,
                                                         GeeMap *actions_map,
                                                         GeeArrayList *mimes);

Parses a launcher to get the text, icon and actions.

launcher :

 . the launcher file (.desktop file) to parse. [in]

icon :

 . the icon key from the launcher. [out]

text :

 . the text key from the launcher. [out]

actions :

 . a list of all actions by name. [in][allow-none]

actions_map :

 . a map of actions from name to exec;;icon. [in][allow-none]

mimes :

 . a list of all supported mime types. [in][allow-none]

struct PlankItemsApplicationDockItem

struct PlankItemsApplicationDockItem;

A dock item for applications (with .desktop launchers).


struct PlankItemsApplicationDockItemClass

struct PlankItemsApplicationDockItemClass {
	PlankItemsDockItemClass parent_class;
};

The class structure for PLANK_ITEMS_TYPE_APPLICATION_DOCK_ITEM. All the fields in this structure are private and should never be accessed directly.

PlankItemsDockItemClass parent_class;

the parent class structure

Property Details

The "App" property

  "App"                      BamfApplication*      : Read / Write / Construct

App.

Signal Details

The "app-closed" signal

void                user_function                      (PlankItemsApplicationDockItem *application_dock_item,
                                                        gpointer                       user_data)                  : Run Last

Signal fired when the application associated with this item closes.

application_dock_item :

the PlankItemsApplicationDockItem instance that received the signal

user_data :

user data set when the signal handler was connected.

The "app-window-added" signal

void                user_function                      (PlankItemsApplicationDockItem *application_dock_item,
                                                        gpointer                       user_data)                  : Run Last

Signal fired when the application associated with this item opened a new window.

application_dock_item :

the PlankItemsApplicationDockItem instance that received the signal

user_data :

user data set when the signal handler was connected.

The "app-window-removed" signal

void                user_function                      (PlankItemsApplicationDockItem *application_dock_item,
                                                        gpointer                       user_data)                  : Run Last

Signal fired when the application associated with this item closed a window.

application_dock_item :

the PlankItemsApplicationDockItem instance that received the signal

user_data :

user data set when the signal handler was connected.

The "pin-launcher" signal

void                user_function                      (PlankItemsApplicationDockItem *application_dock_item,
                                                        gpointer                       user_data)                  : Run Last

Signal fired when the item's 'keep in dock' menu item is pressed.

application_dock_item :

the PlankItemsApplicationDockItem instance that received the signal

user_data :

user data set when the signal handler was connected.