![]() |
![]() |
![]() |
libbamf Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Signals |
#define BAMF_MATCHER_SIGNAL_VIEW_OPENED #define BAMF_MATCHER_SIGNAL_VIEW_CLOSED #define BAMF_MATCHER_SIGNAL_ACTIVE_APPLICATION_CHANGED #define BAMF_MATCHER_SIGNAL_ACTIVE_WINDOW_CHANGED #define BAMF_MATCHER_SIGNAL_STACKING_ORDER_CHANGED struct BamfMatcher; struct BamfMatcherClass; BamfMatcher * bamf_matcher_get_default (void
); BamfApplication * bamf_matcher_get_active_application (BamfMatcher *matcher
); BamfWindow * bamf_matcher_get_active_window (BamfMatcher *matcher
); BamfApplication * bamf_matcher_get_application_for_xid (BamfMatcher *matcher
,guint32 xid
); BamfApplication * bamf_matcher_get_application_for_window (BamfMatcher *matcher
,BamfWindow *window
); gboolean bamf_matcher_application_is_running (BamfMatcher *matcher
,const gchar *desktop_file
); GList * bamf_matcher_get_applications (BamfMatcher *matcher
); void bamf_matcher_register_favorites (BamfMatcher *matcher
,const gchar **favorites
); GList * bamf_matcher_get_running_applications (BamfMatcher *matcher
); GList * bamf_matcher_get_tabs (BamfMatcher *matcher
); GArray * bamf_matcher_get_xids_for_application (BamfMatcher *matcher
,const gchar *desktop_file
); GList * bamf_matcher_get_windows (BamfMatcher *matcher
); GList * bamf_matcher_get_window_stack_for_monitor (BamfMatcher *matcher
,gint monitor
); BamfApplication * bamf_matcher_get_application_for_desktop_file (BamfMatcher *matcher
,const gchar *desktop_file_path
,gboolean create_if_not_found
);
"active-application-changed" "active-window-changed" "stacking-order-changed" "view-closed" "view-opened"
#define BAMF_MATCHER_SIGNAL_ACTIVE_APPLICATION_CHANGED "active-application-changed"
#define BAMF_MATCHER_SIGNAL_ACTIVE_WINDOW_CHANGED "active-window-changed"
#define BAMF_MATCHER_SIGNAL_STACKING_ORDER_CHANGED "stacking-order-changed"
BamfMatcher * bamf_matcher_get_default (void
);
Returns the default matcher. This matcher is owned by bamf and shared between other callers.
Returns : |
A new BamfMatcher. [transfer full] |
BamfApplication * bamf_matcher_get_active_application (BamfMatcher *matcher
);
Used to fetch the active BamfApplication.
|
a BamfMatcher |
Returns : |
The active BamfApplication. [transfer none] |
BamfWindow * bamf_matcher_get_active_window (BamfMatcher *matcher
);
Used to fetch the active BamfWindow.
|
a BamfMatcher |
Returns : |
The active BamfWindow. [transfer none] |
BamfApplication * bamf_matcher_get_application_for_xid (BamfMatcher *matcher
,guint32 xid
);
Used to fetch the BamfApplication containing the passed xid.
|
a BamfMatcher |
|
The XID to search for |
Returns : |
The BamfApplication representing the xid passed, or NULL if none exists. [transfer none] |
BamfApplication * bamf_matcher_get_application_for_window (BamfMatcher *matcher
,BamfWindow *window
);
Used to fetch the BamfApplication containing the passed window.
|
a BamfMatcher |
|
The window to look for |
Returns : |
The BamfApplication representing the xid passed, or NULL if none exists. [transfer none] |
gboolean bamf_matcher_application_is_running (BamfMatcher *matcher
,const gchar *desktop_file
);
GList * bamf_matcher_get_applications (BamfMatcher *matcher
);
Used to fetch all BamfApplication's running or not. Application authors who wish to only see running applications should use bamf_matcher_get_running_applications instead. The reason this method is needed is bamf will occasionally track applications which are not currently running for nefarious purposes.
|
a BamfMatcher |
Returns : |
A list of BamfApplication's. [element-type Bamf.Application][transfer container] |
void bamf_matcher_register_favorites (BamfMatcher *matcher
,const gchar **favorites
);
Used to effect how bamf performs matching. Desktop files passed to this method will be prefered by bamf to system desktop files.
|
a BamfMatcher |
|
an array of strings, each containing an absolute path to a .desktop file. [array] |
GList * bamf_matcher_get_running_applications
(BamfMatcher *matcher
);
Used to fetch all BamfApplication's which are running.
|
a BamfMatcher |
Returns : |
A list of BamfApplication's. [element-type Bamf.Application][transfer container] |
GList * bamf_matcher_get_tabs (BamfMatcher *matcher
);
Used to fetch all BamfView's representing tabs. Currently unused.
|
a BamfMatcher |
Returns : |
A list of BamfTab's. [element-type Bamf.Tab][transfer container] |
GArray * bamf_matcher_get_xids_for_application (BamfMatcher *matcher
,const gchar *desktop_file
);
Used to fetch all xid's associated with an application. Useful for performing window
|
a BamfMatcher |
Returns : |
A list of xids. [element-type guint32][transfer full] |
GList * bamf_matcher_get_windows (BamfMatcher *matcher
);
Used to fetch all windows that BAMF knows about.
|
a BamfMatcher |
Returns : |
A list of BamfWindow's. [element-type Bamf.Window][transfer container] |
GList * bamf_matcher_get_window_stack_for_monitor (BamfMatcher *matcher
,gint monitor
);
Used to fetch all windows that BAMF knows about in the requested screen,
in stacking bottom-to-top order. If the monitor
is set to a negative value,
then it fetches all the available windows in all monitors.
|
a BamfMatcher |
|
the monitor you want the stack from, negative value to get all |
Returns : |
A list of BamfWindow's. [element-type Bamf.Window][transfer container] |
BamfApplication * bamf_matcher_get_application_for_desktop_file (BamfMatcher *matcher
,const gchar *desktop_file_path
,gboolean create_if_not_found
);
|
a BamfMatcher |
|
Path to the desktop file |
|
Create a BamfApplication if one isn't found |
Returns : |
A BamfApplication for given desktop file. [transfer none] |
"active-application-changed"
signalvoid user_function (BamfMatcher *bamfmatcher, BamfApplication *arg1, BamfApplication *arg2, gpointer user_data)
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"active-window-changed"
signalvoid user_function (BamfMatcher *bamfmatcher, BamfWindow *arg1, BamfWindow *arg2, gpointer user_data)
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"stacking-order-changed"
signalvoid user_function (BamfMatcher *bamfmatcher, gpointer user_data)
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"view-closed"
signalvoid user_function (BamfMatcher *bamfmatcher, BamfView *arg1, gpointer user_data)
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"view-opened"
signalvoid user_function (BamfMatcher *bamfmatcher, BamfView *arg1, gpointer user_data)
|
the object which received the signal. |
|
user data set when the signal handler was connected. |