BamfTab

Synopsis

#define             BAMF_TAB_CONST                      (obj)
struct              BamfTab;
struct              BamfTabClass;
void                (*BamfTabPreviewReadyCallback)      (BamfTab *self,
                                                         const gchar *preview_data,
                                                         gpointer user_data);
gboolean            bamf_tab_raise                      (BamfTab *self);
gboolean            bamf_tab_close                      (BamfTab *self);
void                bamf_tab_request_preview            (BamfTab *self,
                                                         BamfTabPreviewReadyCallback callback,
                                                         gpointer user_data);
const gchar *       bamf_tab_get_desktop_name           (BamfTab *self);
const gchar *       bamf_tab_get_location               (BamfTab *self);
guint64             bamf_tab_get_xid                    (BamfTab *self);
gboolean            bamf_tab_get_is_foreground_tab      (BamfTab *self);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----BamfView
               +----BamfTab

Properties

  "desktop-id"               gchar*                : Read
  "is-foreground-tab"        gboolean              : Read
  "location"                 gchar*                : Read
  "xid"                      guint64               : Read

Description

Details

BAMF_TAB_CONST()

#define BAMF_TAB_CONST(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), BAMF_TYPE_TAB, BamfTab const))

struct BamfTab

struct BamfTab;

struct BamfTabClass

struct BamfTabClass {
  BamfViewClass parent_class;

  const gchar * (*get_desktop_name)         (BamfTab *self);
  const gchar * (*get_location)             (BamfTab *self);
  guint64       (*get_xid)                  (BamfTab *self);
  gboolean      (*get_is_foreground_tab)    (BamfTab *self);
};

BamfTabPreviewReadyCallback ()

void                (*BamfTabPreviewReadyCallback)      (BamfTab *self,
                                                         const gchar *preview_data,
                                                         gpointer user_data);

bamf_tab_raise ()

gboolean            bamf_tab_raise                      (BamfTab *self);

Selects the self tab in the parent window.

`self` :	A BamfTab.
Returns :	`TRUE` if success, `FALSE` otherwise.

bamf_tab_close ()

gboolean            bamf_tab_close                      (BamfTab *self);

Closes the selected self tab.

`self` :	A BamfTab.
Returns :	`TRUE` if success, `FALSE` otherwise.

bamf_tab_request_preview ()

void                bamf_tab_request_preview            (BamfTab *self,
                                                         BamfTabPreviewReadyCallback callback,
                                                         gpointer user_data);

`self` :	a BamfTab
`callback` :	a callback function to call when the result is ready. [closure][scope async]
`user_data` :	data to be sent to the callback. [closure][allow-none]

bamf_tab_get_desktop_name ()

const gchar *       bamf_tab_get_desktop_name           (BamfTab *self);

Returns the desktop file for the tab.

`self` :	A BamfTab.
Returns :	The tab desktop id or `NULL` if not set or available. Do not free the returned value, it belongs to `self`. [transfer none]

bamf_tab_get_location ()

const gchar *       bamf_tab_get_location               (BamfTab *self);

bamf_tab_get_xid ()

guint64             bamf_tab_get_xid                    (BamfTab *self);

The desktop file for the tab.

`self` :	A BamfTab.
Returns :	The tab parent window XID id or 0 if not set or available.

bamf_tab_get_is_foreground_tab ()

gboolean            bamf_tab_get_is_foreground_tab      (BamfTab *self);

`self` :	A BamfTab.
Returns :	`TRUE` if the tab is the active one on parent window XID, `FALSE` otherwise.

Property Details

The `"desktop-id"` property

  "desktop-id"               gchar*                : Read

The Desktop ID assosciated with the application hosted in the remote Tab.

Default value: NULL

The `"is-foreground-tab"` property

  "is-foreground-tab"        gboolean              : Read

Whether the tab is the foreground tab in it's toplevel container.

Default value: FALSE

The `"location"` property

  "location"                 gchar*                : Read

The Current location of the remote Tab.