[Xfce4-commits] [apps/xfdashboard] 03/03: Add annotation for API documentation of XfdashboardWindowTracker
noreply at xfce.org
noreply at xfce.org
Fri May 12 08:38:13 CEST 2017
This is an automated email from the git hooks/post-receive script.
nomad pushed a commit to branch master
in repository apps/xfdashboard.
commit 3fe11225a459e5ad523b7937348136c46f9d4ea5
Author: Stephan Haller <nomad at froevel.de>
Date: Fri May 12 08:37:51 2017 +0200
Add annotation for API documentation of XfdashboardWindowTracker
---
libxfdashboard/window-tracker.c | 392 ++++++++++++++++++++++++++++++++++++++--
libxfdashboard/window-tracker.h | 55 ++++++
2 files changed, 430 insertions(+), 17 deletions(-)
diff --git a/libxfdashboard/window-tracker.c b/libxfdashboard/window-tracker.c
index 81dc88e..a96bbd4 100644
--- a/libxfdashboard/window-tracker.c
+++ b/libxfdashboard/window-tracker.c
@@ -122,6 +122,13 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
g_object_interface_install_property(iface, property);
/* Define signals */
+ /**
+ * XfdashboardWindowTracker::window-tacking-changed:
+ * @self: The window tracker
+ *
+ * The ::window-tacking-changed signal is emitted whenever the stacking
+ * order of the windows at the desktop environment has changed.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WINDOW_STACKING_CHANGED]=
g_signal_new("window-stacking-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -133,6 +140,17 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
G_TYPE_NONE,
0);
+ /**
+ * XfdashboardWindowTracker::active-window-changed:
+ * @self: The window tracker
+ * @inPreviousActiveWindow: The #XfdashboardWindowTrackerWindow which
+ * was the active window before this change
+ * @inCurrentActiveWindow: The #XfdashboardWindowTrackerWindow which is
+ * the active window now
+ *
+ * The ::active-window-changed is emitted when the active window has
+ * changed.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_ACTIVE_WINDOW_CHANGED]=
g_signal_new("active-window-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -146,6 +164,14 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
XFDASHBOARD_TYPE_WINDOW_TRACKER_WINDOW,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WINDOW);
+ /**
+ * XfdashboardWindowTracker::window-opened:
+ * @self: The window tracker
+ * @inWindow: The #XfdashboardWindowTrackerWindow opened
+ *
+ * The ::window-opened signal is emitted whenever a new window was opened
+ * at the desktop environment.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WINDOW_OPENED]=
g_signal_new("window-opened",
G_TYPE_FROM_INTERFACE(iface),
@@ -158,6 +184,14 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WINDOW);
+ /**
+ * XfdashboardWindowTracker::window-closed:
+ * @self: The window tracker
+ * @inWindow: The #XfdashboardWindowTrackerWindow closed
+ *
+ * The ::window-closed signal is emitted when a window was closed and is
+ * not available anymore.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WINDOW_CLOSED]=
g_signal_new("window-closed",
G_TYPE_FROM_INTERFACE(iface),
@@ -170,6 +204,14 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WINDOW);
+ /**
+ * XfdashboardWindowTracker::window-geometry-changed:
+ * @self: The window tracker
+ * @inWindow: The #XfdashboardWindowTrackerWindow which changed its size or position
+ *
+ * The ::window-geometry-changed signal is emitted when the size of a
+ * window or its position at screen of the desktop environment has changed.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WINDOW_GEOMETRY_CHANGED]=
g_signal_new("window-geometry-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -182,6 +224,15 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WINDOW);
+ /**
+ * XfdashboardWindowTracker::window-actions-changed:
+ * @self: The window tracker
+ * @inWindow: The #XfdashboardWindowTrackerWindow changed the availability
+ * of actions
+ *
+ * The ::window-actions-changed signal is emitted whenever the availability
+ * of actions of a window changes.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WINDOW_ACTIONS_CHANGED]=
g_signal_new("window-actions-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -194,6 +245,17 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WINDOW);
+ /**
+ * XfdashboardWindowTracker::window-state-changed:
+ * @self: The window tracker
+ * @inWindow: The #XfdashboardWindowTrackerWindow changed its state
+ *
+ * The ::window-state-changed signal is emitted whenever a window
+ * changes its state. This can happen when @inWindow is (un)minimized,
+ * (un)maximized, (un)pinned, (un)set fullscreen etc. See
+ * #XfdashboardWindowTrackerWindowState for the complete list of states
+ * that might have changed.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WINDOW_STATE_CHANGED]=
g_signal_new("window-state-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -206,6 +268,14 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WINDOW);
+ /**
+ * XfdashboardWindowTracker::window-icon-changed:
+ * @self: The window tracker
+ * @inWindow: The #XfdashboardWindowTrackerWindow changed its icon
+ *
+ * The ::window-icon-changed signal is emitted whenever a window
+ * changes its icon
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WINDOW_ICON_CHANGED]=
g_signal_new("window-icon-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -218,6 +288,14 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WINDOW);
+ /**
+ * XfdashboardWindowTracker::window-name-changed:
+ * @self: The window tracker
+ * @inWindow: The #XfdashboardWindowTrackerWindow changed its name
+ *
+ * The ::window-name-changed signal is emitted whenever a window
+ * changes its name, known as window title.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WINDOW_NAME_CHANGED]=
g_signal_new("window-name-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -230,6 +308,16 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WINDOW);
+ /**
+ * XfdashboardWindowTracker::window-workspace-changed:
+ * @self: The window tracker
+ * @inWindow: The #XfdashboardWindowTrackerWindow moved to another workspace
+ * @inWorkspace: The #XfdashboardWindowTrackerWorkspace where the window
+ * @inWindow was moved to
+ *
+ * The ::window-workspace-changed signal is emitted whenever a window
+ * moves to another workspace.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WINDOW_WORKSPACE_CHANGED]=
g_signal_new("window-workspace-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -243,6 +331,18 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
XFDASHBOARD_TYPE_WINDOW_TRACKER_WINDOW,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WORKSPACE);
+ /**
+ * XfdashboardWindowTracker::window-monitor-changed:
+ * @self: The window tracker
+ * @inWindow: The #XfdashboardWindowTrackerWindow moved to another monitor
+ * @inPreviousMonitor: The #XfdashboardWindowTrackerMonitor where the window
+ * @inWindow was located at before this change
+ * @inCurrentMonitor: The #XfdashboardWindowTrackerMonitor where the window
+ * @inWindow is located at now
+ *
+ * The ::window-monitor-changed signal is emitted whenever a window
+ * moves to another monitor.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WINDOW_MONITOR_CHANGED]=
g_signal_new("window-monitor-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -257,6 +357,17 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
XFDASHBOARD_TYPE_WINDOW_TRACKER_MONITOR,
XFDASHBOARD_TYPE_WINDOW_TRACKER_MONITOR);
+ /**
+ * XfdashboardWindowTracker::active-workspace-changed:
+ * @self: The window tracker
+ * @inPreviousActiveWorkspace: The #XfdashboardWindowTrackerWorkspace which
+ * was the active workspace before this change
+ * @inCurrentActiveWorkspace: The #XfdashboardWindowTrackerWorkspace which
+ * is the active workspace now
+ *
+ * The ::active-workspace-changed signal is emitted when the active workspace
+ * has changed.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_ACTIVE_WORKSPACE_CHANGED]=
g_signal_new("active-workspace-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -270,6 +381,13 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
XFDASHBOARD_TYPE_WINDOW_TRACKER_WORKSPACE,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WORKSPACE);
+ /**
+ * XfdashboardWindowTracker::workspace-added:
+ * @self: The window tracker
+ * @inWorkspace: The #XfdashboardWindowTrackerWorkspace added
+ *
+ * The ::workspace-added signal is emitted whenever a new workspace was added.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WORKSPACE_ADDED]=
g_signal_new("workspace-added",
G_TYPE_FROM_INTERFACE(iface),
@@ -282,6 +400,13 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WORKSPACE);
+ /**
+ * XfdashboardWindowTracker::workspace-removed:
+ * @self: The window tracker
+ * @inWorkspace: The #XfdashboardWindowTrackerWorkspace removed
+ *
+ * The ::workspace-removed signal is emitted whenever a workspace was removed.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WORKSPACE_REMOVED]=
g_signal_new("workspace-removed",
G_TYPE_FROM_INTERFACE(iface),
@@ -294,6 +419,14 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WORKSPACE);
+ /**
+ * XfdashboardWindowTracker::workspace-name-changed:
+ * @self: The window tracker
+ * @inWorkspace: The #XfdashboardWindowTrackerWorkspace changed its name
+ *
+ * The ::workspace-name-changed signal is emitted whenever a workspace
+ * changes its name.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WORKSPACE_NAME_CHANGED]=
g_signal_new("workspace-name-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -306,6 +439,17 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_WORKSPACE);
+ /**
+ * XfdashboardWindowTracker::primary-monitor-changed:
+ * @self: The window tracker
+ * @inPreviousPrimaryMonitor: The #XfdashboardWindowTrackerMonitor which
+ * was the primary monitor before this change
+ * @inCurrentPrimaryMonitor: The #XfdashboardWindowTrackerMonitor which
+ * is the new primary monitor now
+ *
+ * The ::primary-monitor-changed signal is emitted when another monitor
+ * was configured to be the primary monitor.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_PRIMARY_MONITOR_CHANGED]=
g_signal_new("primary-monitor-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -319,6 +463,13 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
XFDASHBOARD_TYPE_WINDOW_TRACKER_MONITOR,
XFDASHBOARD_TYPE_WINDOW_TRACKER_MONITOR);
+ /**
+ * XfdashboardWindowTracker::monitor-added:
+ * @self: The window tracker
+ * @inMonitor: The #XfdashboardWindowTrackerMonitor added
+ *
+ * The ::monitor-added signal is emitted whenever a new monitor was added.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_MONITOR_ADDED]=
g_signal_new("monitor-added",
G_TYPE_FROM_INTERFACE(iface),
@@ -331,6 +482,13 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_MONITOR);
+ /**
+ * XfdashboardWindowTracker::monitor-removed:
+ * @self: The window tracker
+ * @inMonitor: The #XfdashboardWindowTrackerMonitor removed
+ *
+ * The ::monitor-removed signal is emitted whenever a monitor was removed.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_MONITOR_REMOVED]=
g_signal_new("monitor-removed",
G_TYPE_FROM_INTERFACE(iface),
@@ -343,6 +501,14 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_MONITOR);
+ /**
+ * XfdashboardWindowTracker::monitor-geometry-changed:
+ * @self: The window tracker
+ * @inMonitor: The #XfdashboardWindowTrackerMonitor which changed its size or position
+ *
+ * The ::monitor-geometry-changed signal is emitted when the size of a
+ * monitor or its position at screen of the desktop environment has changed.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_MONITOR_GEOMETRY_CHANGED]=
g_signal_new("monitor-geometry-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -355,6 +521,14 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
1,
XFDASHBOARD_TYPE_WINDOW_TRACKER_MONITOR);
+ /**
+ * XfdashboardWindowTracker::screen-size-changed:
+ * @self: The window tracker
+ *
+ * The ::screen-size-changed signal is emitted when the screen size of
+ * the desktop environment has been changed, e.g. one monitor changed its
+ * resolution.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_SCREEN_SIZE_CHANGED]=
g_signal_new("screen-size-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -366,6 +540,13 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
G_TYPE_NONE,
0);
+ /**
+ * XfdashboardWindowTracker::window-manager-changed:
+ * @self: The window tracker
+ *
+ * The ::window-manager-changed signal is emitted when the window manager
+ * of the desktop environment has been replaced with a new one.
+ */
XfdashboardWindowTrackerSignals[SIGNAL_WINDOW_MANAGER_CHANGED]=
g_signal_new("window-manager-changed",
G_TYPE_FROM_INTERFACE(iface),
@@ -385,7 +566,14 @@ void xfdashboard_window_tracker_default_init(XfdashboardWindowTrackerInterface *
/* IMPLEMENTATION: Public API */
-/* Create new instance */
+/**
+ * xfdashboard_window_tracker_get_default:
+ *
+ * Retrieves the singleton instance of #XfdashboardWindowTracker. If not needed
+ * anymore the caller must unreference the returned object instance.
+ *
+ * Return value: (transfer full): The instance of #XfdashboardWindowTracker.
+ */
XfdashboardWindowTracker* xfdashboard_window_tracker_get_default(void)
{
if(G_UNLIKELY(_xfdashboard_window_tracker_singleton==NULL))
@@ -399,7 +587,18 @@ XfdashboardWindowTracker* xfdashboard_window_tracker_get_default(void)
}
-/* Get list of all windows (if wanted in stack order) */
+/**
+ * xfdashboard_window_tracker_get_windows:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Retrieves the list of #XfdashboardWindowTrackerWindow tracked by @self.
+ * The list is ordered: the first element in the list is the first
+ * #XfdashboardWindowTrackerWindow, etc..
+ *
+ * Return value: (element-type XfdashboardWindowTrackerWindow) (transfer none):
+ * The list of #XfdashboardWindowTrackerWindow. The list should not be modified
+ * nor freed, as it is owned by Xfdashboard.
+ */
GList* xfdashboard_window_tracker_get_windows(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -419,6 +618,18 @@ GList* xfdashboard_window_tracker_get_windows(XfdashboardWindowTracker *self)
return(NULL);
}
+/**
+ * xfdashboard_window_tracker_get_windows_stacked:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Retrieves the list of #XfdashboardWindowTrackerWindow tracked by @self in
+ * stacked order from bottom to top. The list is ordered: the first element in
+ * the list is the most bottom #XfdashboardWindowTrackerWindow, etc..
+ *
+ * Return value: (element-type XfdashboardWindowTrackerWindow) (transfer none):
+ * The list of #XfdashboardWindowTrackerWindow in stacked order. The list should
+ * not be modified nor freed, as it is owned by Xfdashboard.
+ */
GList* xfdashboard_window_tracker_get_windows_stacked(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -438,7 +649,16 @@ GList* xfdashboard_window_tracker_get_windows_stacked(XfdashboardWindowTracker *
return(NULL);
}
-/* Get active window */
+/**
+ * xfdashboard_window_tracker_get_active_window:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Retrieves the currently active #XfdashboardWindowTrackerWindow.
+ *
+ * Return value: (transfer none): The #XfdashboardWindowTrackerWindow currently
+ * active or %NULL if not determinable. The returned object is owned by Xfdashboard
+ * and it should not be referenced or unreferenced.
+ */
XfdashboardWindowTrackerWindow* xfdashboard_window_tracker_get_active_window(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -458,7 +678,14 @@ XfdashboardWindowTrackerWindow* xfdashboard_window_tracker_get_active_window(Xfd
return(NULL);
}
-/* Get number of workspaces */
+/**
+ * xfdashboard_window_tracker_get_workspaces_count:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Retrieves the number of #XfdashboardWindowTrackerWorkspace tracked by @self.
+ *
+ * Return value: The number of #XfdashboardWindowTrackerWorkspace
+ */
gint xfdashboard_window_tracker_get_workspaces_count(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -478,7 +705,18 @@ gint xfdashboard_window_tracker_get_workspaces_count(XfdashboardWindowTracker *s
return(0);
}
-/* Get list of workspaces */
+/**
+ * xfdashboard_window_tracker_get_workspaces:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Retrieves the list of #XfdashboardWindowTrackerWorkspace tracked by @self.
+ * The list is ordered: the first element in the list is the first
+ * #XfdashboardWindowTrackerWorkspace, etc..
+ *
+ * Return value: (element-type XfdashboardWindowTrackerWorkspace) (transfer none):
+ * The list of #XfdashboardWindowTrackerWorkspace. The list should not be modified
+ * nor freed, as it is owned by Xfdashboard.
+ */
GList* xfdashboard_window_tracker_get_workspaces(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -498,7 +736,16 @@ GList* xfdashboard_window_tracker_get_workspaces(XfdashboardWindowTracker *self)
return(NULL);
}
-/* Get active workspace */
+/**
+ * xfdashboard_window_tracker_get_active_workspace:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Retrieves the currently active #XfdashboardWindowTrackerWorkspace.
+ *
+ * Return value: (transfer none): The #XfdashboardWindowTrackerWorkspace currently
+ * active or %NULL if not determinable. The returned object is owned by Xfdashboard
+ * and it should not be referenced or unreferenced.
+ */
XfdashboardWindowTrackerWorkspace* xfdashboard_window_tracker_get_active_workspace(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -518,7 +765,17 @@ XfdashboardWindowTrackerWorkspace* xfdashboard_window_tracker_get_active_workspa
return(NULL);
}
-/* Get workspace by number */
+/**
+ * xfdashboard_window_tracker_get_workspace_by_number:
+ * @self: A #XfdashboardWindowTracker
+ * @inNumber: The workspace index, starting from 0
+ *
+ * Retrieves the #XfdashboardWindowTrackerWorkspace at index @inNumber.
+ *
+ * Return value: (transfer none): The #XfdashboardWindowTrackerWorkspace at the
+ * index or %NULL if no such workspace exists. The returned object is owned by
+ * Xfdashboard and it should not be referenced or unreferenced.
+ */
XfdashboardWindowTrackerWorkspace* xfdashboard_window_tracker_get_workspace_by_number(XfdashboardWindowTracker *self,
gint inNumber)
{
@@ -541,7 +798,22 @@ XfdashboardWindowTrackerWorkspace* xfdashboard_window_tracker_get_workspace_by_n
return(NULL);
}
-/* Determine if multiple monitors are supported */
+/**
+ * xfdashboard_window_tracker_get_monitors_count:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Determines if window tracker at @self supports multiple monitors.
+ *
+ * If multiple monitors are supported, %TRUE will be returned and the number
+ * of monitors can be determined by calling xfdashboard_window_tracker_get_monitors_count().
+ * Also each monitor can be accessed xfdashboard_window_tracker_get_monitor_by_number()
+ * and other monitor related functions.
+ *
+ * If multiple monitors are not supported or the desktop environment cannot provide
+ * this kind of information, %FALSE will be returned.
+ *
+ * Return value: %TRUE if @self supports multiple monitors, otherwise %FALSE.
+ */
gboolean xfdashboard_window_tracker_supports_multiple_monitors(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -561,7 +833,14 @@ gboolean xfdashboard_window_tracker_supports_multiple_monitors(XfdashboardWindow
return(FALSE);
}
-/* Get number of monitors */
+/**
+ * xfdashboard_window_tracker_get_monitors_count:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Retrieves the number of #XfdashboardWindowTrackerMonitor tracked by @self.
+ *
+ * Return value: The number of #XfdashboardWindowTrackerMonitor
+ */
gint xfdashboard_window_tracker_get_monitors_count(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -581,7 +860,18 @@ gint xfdashboard_window_tracker_get_monitors_count(XfdashboardWindowTracker *sel
return(0);
}
-/* Get list of monitors */
+/**
+ * xfdashboard_window_tracker_get_monitors:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Retrieves the list of #XfdashboardWindowTrackerMonitor tracked by @self.
+ * The list is ordered: the first element in the list is the first #XfdashboardWindowTrackerMonitor,
+ * etc..
+ *
+ * Return value: (element-type XfdashboardWindowTrackerMonitor) (transfer none):
+ * The list of #XfdashboardWindowTrackerMonitor. The list should not be modified
+ * nor freed, as it is owned by Xfdashboard.
+ */
GList* xfdashboard_window_tracker_get_monitors(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -601,7 +891,17 @@ GList* xfdashboard_window_tracker_get_monitors(XfdashboardWindowTracker *self)
return(NULL);
}
-/* Get primary monitor */
+/**
+ * xfdashboard_window_tracker_get_primary_monitor:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Retrieves the primary #XfdashboardWindowTrackerMonitor the user configured
+ * at its desktop environment.
+ *
+ * Return value: (transfer none): The #XfdashboardWindowTrackerMonitor configured
+ * as primary or %NULL if no primary monitor exists. The returned object is
+ * owned by Xfdashboard and it should not be referenced or unreferenced.
+ */
XfdashboardWindowTrackerMonitor* xfdashboard_window_tracker_get_primary_monitor(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -621,7 +921,17 @@ XfdashboardWindowTrackerMonitor* xfdashboard_window_tracker_get_primary_monitor(
return(NULL);
}
-/* Get monitor by number */
+/**
+ * xfdashboard_window_tracker_get_monitor_by_number:
+ * @self: A #XfdashboardWindowTracker
+ * @inNumber: The monitor index, starting from 0
+ *
+ * Retrieves the #XfdashboardWindowTrackerMonitor at index @inNumber.
+ *
+ * Return value: (transfer none): The #XfdashboardWindowTrackerMonitor at the
+ * index or %NULL if no such monitor exists. The returned object is owned by
+ * Xfdashboard and it should not be referenced or unreferenced.
+ */
XfdashboardWindowTrackerMonitor* xfdashboard_window_tracker_get_monitor_by_number(XfdashboardWindowTracker *self,
gint inNumber)
{
@@ -644,7 +954,19 @@ XfdashboardWindowTrackerMonitor* xfdashboard_window_tracker_get_monitor_by_numbe
return(NULL);
}
-/* Get monitor at position */
+/**
+ * xfdashboard_window_tracker_get_monitor_by_position:
+ * @self: A #XfdashboardWindowTracker
+ * @inX: The X coordinate of position at screen
+ * @inY: The Y coordinate of position at screen
+ *
+ * Retrieves the monitor containing the position at @inX, at inY at screen.
+ *
+ * Return value: (transfer none): The #XfdashboardWindowTrackerMonitor for the
+ * requested position or %NULL if no monitor could be found containing the
+ * position. The returned object is owned by Xfdashboard and it should not be
+ * referenced or unreferenced.
+ */
XfdashboardWindowTrackerMonitor* xfdashboard_window_tracker_get_monitor_by_position(XfdashboardWindowTracker *self,
gint inX,
gint inY)
@@ -666,7 +988,15 @@ XfdashboardWindowTrackerMonitor* xfdashboard_window_tracker_get_monitor_by_posit
return(NULL);
}
-/* Get width and height of screen */
+/**
+ * xfdashboard_window_tracker_get_screen_size:
+ * @self: A #XfdashboardWindowTracker
+ * @outWidth: (out): Return location for width of screen.
+ * @outHeight: (out): Return location for height of screen.
+ *
+ * Retrieves width and height of screen of the desktop environment. The screen
+ * contains all connected monitors so it the total size of the desktop environment.
+ */
void xfdashboard_window_tracker_get_screen_size(XfdashboardWindowTracker *self, gint *outWidth, gint *outHeight)
{
XfdashboardWindowTrackerInterface *iface;
@@ -693,7 +1023,15 @@ void xfdashboard_window_tracker_get_screen_size(XfdashboardWindowTracker *self,
XFDASHBOARD_WINDOWS_TRACKER_WARN_NOT_IMPLEMENTED(self, "get_screen_width");
}
-/* Get name of window manager managing windows, workspace etc. of desktop environment */
+/**
+ * xfdashboard_window_tracker_get_window_manager_name:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Retrieves the name of window manager managing the desktop environment, i.e.
+ * windows, workspaces etc.
+ *
+ * Return value: A string with name of the window manager
+ */
const gchar* xfdashboard_window_tracker_get_window_manager_name(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -713,7 +1051,17 @@ const gchar* xfdashboard_window_tracker_get_window_manager_name(XfdashboardWindo
return(NULL);
}
-/* Get root (desktop) window */
+/**
+ * xfdashboard_window_tracker_get_root_window:
+ * @self: A #XfdashboardWindowTracker
+ *
+ * Retrieves the root window of the desktop environment. The root window is
+ * usually the desktop seen at the background of the desktop environment.
+ *
+ * Return value: (transfer none): The #XfdashboardWindowTrackerWindow representing
+ * the root window or %NULL if not available. The returned object is owned by
+ * Xfdashboard and it should not be referenced or unreferenced.
+ */
XfdashboardWindowTrackerWindow* xfdashboard_window_tracker_get_root_window(XfdashboardWindowTracker *self)
{
XfdashboardWindowTrackerInterface *iface;
@@ -733,7 +1081,17 @@ XfdashboardWindowTrackerWindow* xfdashboard_window_tracker_get_root_window(Xfdas
return(NULL);
}
-/* Get window of stage*/
+/**
+ * xfdashboard_window_tracker_get_stage_window:
+ * @self: A #XfdashboardWindowTracker
+ * @inStage: A #ClutterStage
+ *
+ * Retrieves the window created for the requested stage @inStage.
+ *
+ * Return value: (transfer none): The #XfdashboardWindowTrackerWindow representing
+ * the window of requested stage or %NULL if not available. The returned object
+ * is owned by Xfdashboard and it should not be referenced or unreferenced.
+ */
XfdashboardWindowTrackerWindow* xfdashboard_window_tracker_get_stage_window(XfdashboardWindowTracker *self,
ClutterStage *inStage)
{
diff --git a/libxfdashboard/window-tracker.h b/libxfdashboard/window-tracker.h
index 68d434f..ed1fc2f 100644
--- a/libxfdashboard/window-tracker.h
+++ b/libxfdashboard/window-tracker.h
@@ -37,6 +37,7 @@
G_BEGIN_DECLS
+/* Object declaration */
#define XFDASHBOARD_TYPE_WINDOW_TRACKER (xfdashboard_window_tracker_get_type())
#define XFDASHBOARD_WINDOW_TRACKER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), XFDASHBOARD_TYPE_WINDOW_TRACKER, XfdashboardWindowTracker))
#define XFDASHBOARD_IS_WINDOW_TRACKER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), XFDASHBOARD_TYPE_WINDOW_TRACKER))
@@ -45,6 +46,59 @@ G_BEGIN_DECLS
typedef struct _XfdashboardWindowTracker XfdashboardWindowTracker;
typedef struct _XfdashboardWindowTrackerInterface XfdashboardWindowTrackerInterface;
+/**
+ * XfdashboardWindowTrackerInterface:
+ * @get_windows: Get list of windows tracked
+ * @get_windows_stacked: Get list of windows tracked in stacked order
+ * (from bottom to top)
+ * @get_active_window: Get the current active window
+ * @get_workspaces_count: Get number of workspaces
+ * @get_workspaces: Get list of workspaces tracked
+ * @get_active_workspace: Get the current active workspace
+ * @get_workspace_by_number: Get workspace by its index
+ * @supports_multiple_monitors: Whether the window trackers supports and tracks
+ * multiple monitors or not
+ * @get_monitors_count: Get number of monitors
+ * @get_monitors: Get list of monitors tracked
+ * @get_primary_monitor: Get the current primary monitor
+ * @get_monitor_by_number: Get monitor by its index
+ * @get_monitor_by_position: Get monitor by looking up if it contains the
+ * requested position
+ * @get_screen_size: Get total size of screen (size over all connected monitors)
+ * @get_window_manager_name: Get name of window manager at desktop environment
+ * @get_root_window: Get root window (usually the desktop at background)
+ * @get_stage_window: Get window for requested stage at @inStage
+ * @window_stacking_changed: Signal emitted when the stacking order of windows
+ * has changed
+ * @active_window_changed: Signal emitted when the active window has changed,
+ * e.g. focus moved to another window
+ * @window_opened: Signal emitted when a new window was opened
+ * @window_closed: Signal emitted when a window was closed
+ * @window_geometry_changed: Signal emitted when a window has changed its
+ * position or size or both
+ * @window_actions_changed: Signal emitted when the available action of a window
+ * has changed
+ * @window_state_changed: Signal emitted when the state of a window has changed
+ * @window_icon_changed: Signal emitted when the icon of a window has changed
+ * @window_name_changed: Signal emitted when the title of a window has changed
+ * @window_workspace_changed: Signal emitted when a window was moved to another
+ * workspace
+ * @window_monitor_changed: Signal emitted when a window was moved to another
+ * monitor
+ * @active_workspace_changed: Signal emitted when the active workspace has changed
+ * @workspace_added: Signal emitted when a new workspace was added
+ * @workspace_removed: Signal emitted when a workspace was removed
+ * @workspace_name_changed: Signal emitted when the title of a workspace has
+ * changed
+ * @primary_monitor_changed: Signal emitted when the primary monitor has changed
+ * @monitor_added: Signal emitted when a new monitor was connected
+ * @monitor_removed: Signal emitted when a monitor was disconnected or turned off
+ * @monitor_geometry_changed: Signal emitted when the resolution of a monitor
+ * has chnaged
+ * @screen_size_changed: Signal emitted when the total screen size over all
+ * connected monitors has changed
+ * @window_manager_changed: Signal emitted when the window manager was replaced
+ */
struct _XfdashboardWindowTrackerInterface
{
/*< private >*/
@@ -116,6 +170,7 @@ struct _XfdashboardWindowTrackerInterface
void (*window_manager_changed)(XfdashboardWindowTracker *self);
};
+
/* Public API */
GType xfdashboard_window_tracker_get_type(void) G_GNUC_CONST;
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the Xfce4-commits
mailing list