diff options
author | Vincent Untz <vuntz@gnome.org> | 2007-06-10 11:53:04 +0000 |
---|---|---|
committer | Vincent Untz <vuntz@src.gnome.org> | 2007-06-10 11:53:04 +0000 |
commit | f985d70f99b4b604ee3b2a697ef4c4a75c62e167 (patch) | |
tree | 474b70e28cc8ac37199146eab3016be5b66cb52a /doc/tmpl/window.sgml | |
parent | 2ec58a2333a2abc5557fb93d41bea994dd5ccf07 (diff) | |
download | libwnck-f985d70f99b4b604ee3b2a697ef4c4a75c62e167.tar.gz |
reorganize a bit some of the functions.
2007-06-10 Vincent Untz <vuntz@gnome.org>
* doc/*: reorganize a bit some of the functions.
svn path=/trunk/; revision=1294
Diffstat (limited to 'doc/tmpl/window.sgml')
-rw-r--r-- | doc/tmpl/window.sgml | 322 |
1 files changed, 161 insertions, 161 deletions
diff --git a/doc/tmpl/window.sgml b/doc/tmpl/window.sgml index 2e726c0..1b7d2de 100644 --- a/doc/tmpl/window.sgml +++ b/doc/tmpl/window.sgml @@ -123,6 +123,33 @@ WnckWindow @Returns: +<!-- ##### FUNCTION wnck_window_get_icon_is_fallback ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION wnck_window_get_icon ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION wnck_window_get_mini_icon ##### --> +<para> + +</para> + +@window: +@Returns: + + <!-- ##### FUNCTION wnck_window_get_application ##### --> <para> @@ -245,16 +272,25 @@ WnckWindow @wintype: -<!-- ##### FUNCTION wnck_window_is_minimized ##### --> +<!-- ##### ENUM WnckWindowState ##### --> <para> </para> -@window: -@Returns: - +@WNCK_WINDOW_STATE_MINIMIZED: +@WNCK_WINDOW_STATE_MAXIMIZED_HORIZONTALLY: +@WNCK_WINDOW_STATE_MAXIMIZED_VERTICALLY: +@WNCK_WINDOW_STATE_SHADED: +@WNCK_WINDOW_STATE_SKIP_PAGER: +@WNCK_WINDOW_STATE_SKIP_TASKLIST: +@WNCK_WINDOW_STATE_STICKY: +@WNCK_WINDOW_STATE_HIDDEN: +@WNCK_WINDOW_STATE_FULLSCREEN: +@WNCK_WINDOW_STATE_DEMANDS_ATTENTION: +@WNCK_WINDOW_STATE_URGENT: +@WNCK_WINDOW_STATE_ABOVE: -<!-- ##### FUNCTION wnck_window_is_maximized_horizontally ##### --> +<!-- ##### FUNCTION wnck_window_get_state ##### --> <para> </para> @@ -263,7 +299,7 @@ WnckWindow @Returns: -<!-- ##### FUNCTION wnck_window_is_maximized_vertically ##### --> +<!-- ##### FUNCTION wnck_window_is_minimized ##### --> <para> </para> @@ -272,7 +308,7 @@ WnckWindow @Returns: -<!-- ##### FUNCTION wnck_window_is_maximized ##### --> +<!-- ##### FUNCTION wnck_window_is_maximized_horizontally ##### --> <para> </para> @@ -281,7 +317,7 @@ WnckWindow @Returns: -<!-- ##### FUNCTION wnck_window_is_shaded ##### --> +<!-- ##### FUNCTION wnck_window_is_maximized_vertically ##### --> <para> </para> @@ -290,20 +326,22 @@ WnckWindow @Returns: -<!-- ##### FUNCTION wnck_window_shade ##### --> +<!-- ##### FUNCTION wnck_window_is_maximized ##### --> <para> </para> @window: +@Returns: -<!-- ##### FUNCTION wnck_window_unshade ##### --> +<!-- ##### FUNCTION wnck_window_is_shaded ##### --> <para> </para> @window: +@Returns: <!-- ##### FUNCTION wnck_window_is_pinned ##### --> @@ -315,23 +353,25 @@ WnckWindow @Returns: -<!-- ##### FUNCTION wnck_window_pin ##### --> +<!-- ##### FUNCTION wnck_window_is_sticky ##### --> <para> </para> @window: +@Returns: -<!-- ##### FUNCTION wnck_window_unpin ##### --> +<!-- ##### FUNCTION wnck_window_is_above ##### --> <para> </para> @window: +@Returns: -<!-- ##### FUNCTION wnck_window_is_sticky ##### --> +<!-- ##### FUNCTION wnck_window_is_skip_pager ##### --> <para> </para> @@ -340,23 +380,25 @@ WnckWindow @Returns: -<!-- ##### FUNCTION wnck_window_stick ##### --> +<!-- ##### FUNCTION wnck_window_is_skip_tasklist ##### --> <para> </para> @window: +@Returns: -<!-- ##### FUNCTION wnck_window_unstick ##### --> +<!-- ##### FUNCTION wnck_window_is_fullscreen ##### --> <para> </para> @window: +@Returns: -<!-- ##### FUNCTION wnck_window_is_above ##### --> +<!-- ##### FUNCTION wnck_window_needs_attention ##### --> <para> </para> @@ -365,23 +407,41 @@ WnckWindow @Returns: -<!-- ##### FUNCTION wnck_window_make_above ##### --> +<!-- ##### FUNCTION wnck_window_or_transient_needs_attention ##### --> <para> </para> @window: +@Returns: -<!-- ##### FUNCTION wnck_window_unmake_above ##### --> +<!-- ##### ENUM WnckWindowActions ##### --> <para> </para> -@window: - +@WNCK_WINDOW_ACTION_MOVE: +@WNCK_WINDOW_ACTION_RESIZE: +@WNCK_WINDOW_ACTION_SHADE: +@WNCK_WINDOW_ACTION_STICK: +@WNCK_WINDOW_ACTION_MAXIMIZE_HORIZONTALLY: +@WNCK_WINDOW_ACTION_MAXIMIZE_VERTICALLY: +@WNCK_WINDOW_ACTION_CHANGE_WORKSPACE: +@WNCK_WINDOW_ACTION_CLOSE: +@WNCK_WINDOW_ACTION_UNMAXIMIZE_HORIZONTALLY: +@WNCK_WINDOW_ACTION_UNMAXIMIZE_VERTICALLY: +@WNCK_WINDOW_ACTION_UNSHADE: +@WNCK_WINDOW_ACTION_UNSTICK: +@WNCK_WINDOW_ACTION_MINIMIZE: +@WNCK_WINDOW_ACTION_UNMINIMIZE: +@WNCK_WINDOW_ACTION_MAXIMIZE: +@WNCK_WINDOW_ACTION_UNMAXIMIZE: +@WNCK_WINDOW_ACTION_FULLSCREEN: +@WNCK_WINDOW_ACTION_ABOVE: +@WNCK_WINDOW_ACTION_BELOW: -<!-- ##### FUNCTION wnck_window_is_skip_pager ##### --> +<!-- ##### FUNCTION wnck_window_get_actions ##### --> <para> </para> @@ -390,333 +450,247 @@ WnckWindow @Returns: -<!-- ##### FUNCTION wnck_window_set_skip_pager ##### --> +<!-- ##### FUNCTION wnck_window_minimize ##### --> <para> </para> @window: -@skip: -<!-- ##### FUNCTION wnck_window_is_skip_tasklist ##### --> +<!-- ##### FUNCTION wnck_window_unminimize ##### --> <para> </para> @window: -@Returns: +@timestamp: -<!-- ##### FUNCTION wnck_window_set_skip_tasklist ##### --> +<!-- ##### FUNCTION wnck_window_maximize_horizontally ##### --> <para> </para> @window: -@skip: -<!-- ##### FUNCTION wnck_window_is_fullscreen ##### --> +<!-- ##### FUNCTION wnck_window_unmaximize_horizontally ##### --> <para> </para> @window: -@Returns: -<!-- ##### FUNCTION wnck_window_set_fullscreen ##### --> +<!-- ##### FUNCTION wnck_window_maximize_vertically ##### --> <para> </para> @window: -@fullscreen: -<!-- ##### FUNCTION wnck_window_needs_attention ##### --> +<!-- ##### FUNCTION wnck_window_unmaximize_vertically ##### --> <para> </para> @window: -@Returns: -<!-- ##### FUNCTION wnck_window_or_transient_needs_attention ##### --> +<!-- ##### FUNCTION wnck_window_maximize ##### --> <para> </para> @window: -@Returns: -<!-- ##### FUNCTION wnck_window_get_workspace ##### --> +<!-- ##### FUNCTION wnck_window_unmaximize ##### --> <para> </para> @window: -@Returns: -<!-- ##### FUNCTION wnck_window_is_on_workspace ##### --> +<!-- ##### FUNCTION wnck_window_shade ##### --> <para> </para> @window: -@workspace: -@Returns: -<!-- ##### FUNCTION wnck_window_is_visible_on_workspace ##### --> +<!-- ##### FUNCTION wnck_window_unshade ##### --> <para> </para> @window: -@workspace: -@Returns: -<!-- ##### FUNCTION wnck_window_move_to_workspace ##### --> +<!-- ##### FUNCTION wnck_window_pin ##### --> <para> </para> @window: -@space: -<!-- ##### FUNCTION wnck_window_is_in_viewport ##### --> +<!-- ##### FUNCTION wnck_window_unpin ##### --> <para> </para> @window: -@workspace: -@Returns: -<!-- ##### FUNCTION wnck_window_activate ##### --> +<!-- ##### FUNCTION wnck_window_stick ##### --> <para> </para> @window: -@timestamp: -<!-- ##### FUNCTION wnck_window_is_active ##### --> +<!-- ##### FUNCTION wnck_window_unstick ##### --> <para> </para> @window: -@Returns: -<!-- ##### FUNCTION wnck_window_is_most_recently_activated ##### --> +<!-- ##### FUNCTION wnck_window_make_above ##### --> <para> </para> @window: -@Returns: -<!-- ##### FUNCTION wnck_window_activate_transient ##### --> +<!-- ##### FUNCTION wnck_window_unmake_above ##### --> <para> </para> @window: -@timestamp: -<!-- ##### FUNCTION wnck_window_transient_is_most_recently_activated ##### --> +<!-- ##### FUNCTION wnck_window_set_skip_pager ##### --> <para> </para> @window: -@Returns: +@skip: -<!-- ##### FUNCTION wnck_window_get_icon ##### --> +<!-- ##### FUNCTION wnck_window_set_skip_tasklist ##### --> <para> </para> @window: -@Returns: +@skip: -<!-- ##### FUNCTION wnck_window_get_mini_icon ##### --> +<!-- ##### FUNCTION wnck_window_set_fullscreen ##### --> <para> </para> @window: -@Returns: +@fullscreen: -<!-- ##### FUNCTION wnck_window_get_icon_is_fallback ##### --> +<!-- ##### FUNCTION wnck_window_close ##### --> <para> </para> @window: -@Returns: +@timestamp: -<!-- ##### FUNCTION wnck_window_set_icon_geometry ##### --> +<!-- ##### FUNCTION wnck_window_get_workspace ##### --> <para> </para> @window: -@x: -@y: -@width: -@height: - - -<!-- ##### ENUM WnckWindowActions ##### --> -<para> - -</para> +@Returns: -@WNCK_WINDOW_ACTION_MOVE: -@WNCK_WINDOW_ACTION_RESIZE: -@WNCK_WINDOW_ACTION_SHADE: -@WNCK_WINDOW_ACTION_STICK: -@WNCK_WINDOW_ACTION_MAXIMIZE_HORIZONTALLY: -@WNCK_WINDOW_ACTION_MAXIMIZE_VERTICALLY: -@WNCK_WINDOW_ACTION_CHANGE_WORKSPACE: -@WNCK_WINDOW_ACTION_CLOSE: -@WNCK_WINDOW_ACTION_UNMAXIMIZE_HORIZONTALLY: -@WNCK_WINDOW_ACTION_UNMAXIMIZE_VERTICALLY: -@WNCK_WINDOW_ACTION_UNSHADE: -@WNCK_WINDOW_ACTION_UNSTICK: -@WNCK_WINDOW_ACTION_MINIMIZE: -@WNCK_WINDOW_ACTION_UNMINIMIZE: -@WNCK_WINDOW_ACTION_MAXIMIZE: -@WNCK_WINDOW_ACTION_UNMAXIMIZE: -@WNCK_WINDOW_ACTION_FULLSCREEN: -@WNCK_WINDOW_ACTION_ABOVE: -@WNCK_WINDOW_ACTION_BELOW: -<!-- ##### FUNCTION wnck_window_get_actions ##### --> +<!-- ##### FUNCTION wnck_window_is_on_workspace ##### --> <para> </para> @window: +@workspace: @Returns: -<!-- ##### ENUM WnckWindowState ##### --> -<para> - -</para> - -@WNCK_WINDOW_STATE_MINIMIZED: -@WNCK_WINDOW_STATE_MAXIMIZED_HORIZONTALLY: -@WNCK_WINDOW_STATE_MAXIMIZED_VERTICALLY: -@WNCK_WINDOW_STATE_SHADED: -@WNCK_WINDOW_STATE_SKIP_PAGER: -@WNCK_WINDOW_STATE_SKIP_TASKLIST: -@WNCK_WINDOW_STATE_STICKY: -@WNCK_WINDOW_STATE_HIDDEN: -@WNCK_WINDOW_STATE_FULLSCREEN: -@WNCK_WINDOW_STATE_DEMANDS_ATTENTION: -@WNCK_WINDOW_STATE_URGENT: -@WNCK_WINDOW_STATE_ABOVE: - -<!-- ##### FUNCTION wnck_window_get_state ##### --> +<!-- ##### FUNCTION wnck_window_is_visible_on_workspace ##### --> <para> </para> @window: +@workspace: @Returns: -<!-- ##### ENUM WnckWindowGravity ##### --> +<!-- ##### FUNCTION wnck_window_move_to_workspace ##### --> <para> </para> -@WNCK_WINDOW_GRAVITY_CURRENT: -@WNCK_WINDOW_GRAVITY_NORTHWEST: -@WNCK_WINDOW_GRAVITY_NORTH: -@WNCK_WINDOW_GRAVITY_NORTHEAST: -@WNCK_WINDOW_GRAVITY_WEST: -@WNCK_WINDOW_GRAVITY_CENTER: -@WNCK_WINDOW_GRAVITY_EAST: -@WNCK_WINDOW_GRAVITY_SOUTHWEST: -@WNCK_WINDOW_GRAVITY_SOUTH: -@WNCK_WINDOW_GRAVITY_SOUTHEAST: -@WNCK_WINDOW_GRAVITY_STATIC: - -<!-- ##### ENUM WnckWindowMoveResizeMask ##### --> -<para> - -</para> +@window: +@space: -@WNCK_WINDOW_CHANGE_X: -@WNCK_WINDOW_CHANGE_Y: -@WNCK_WINDOW_CHANGE_WIDTH: -@WNCK_WINDOW_CHANGE_HEIGHT: -<!-- ##### FUNCTION wnck_window_get_geometry ##### --> +<!-- ##### FUNCTION wnck_window_is_in_viewport ##### --> <para> </para> @window: -@xp: -@yp: -@widthp: -@heightp: +@workspace: +@Returns: -<!-- ##### FUNCTION wnck_window_set_geometry ##### --> +<!-- ##### FUNCTION wnck_window_activate ##### --> <para> </para> @window: -@gravity: -@geometry_mask: -@x: -@y: -@width: -@height: +@timestamp: -<!-- ##### FUNCTION wnck_window_close ##### --> +<!-- ##### FUNCTION wnck_window_is_active ##### --> <para> </para> @window: -@timestamp: +@Returns: -<!-- ##### FUNCTION wnck_window_minimize ##### --> +<!-- ##### FUNCTION wnck_window_is_most_recently_activated ##### --> <para> </para> @window: +@Returns: -<!-- ##### FUNCTION wnck_window_unminimize ##### --> +<!-- ##### FUNCTION wnck_window_activate_transient ##### --> <para> </para> @@ -725,52 +699,78 @@ WnckWindow @timestamp: -<!-- ##### FUNCTION wnck_window_maximize ##### --> +<!-- ##### FUNCTION wnck_window_transient_is_most_recently_activated ##### --> <para> </para> @window: +@Returns: -<!-- ##### FUNCTION wnck_window_unmaximize ##### --> +<!-- ##### FUNCTION wnck_window_set_icon_geometry ##### --> <para> </para> @window: +@x: +@y: +@width: +@height: -<!-- ##### FUNCTION wnck_window_maximize_horizontally ##### --> +<!-- ##### ENUM WnckWindowGravity ##### --> <para> </para> -@window: - +@WNCK_WINDOW_GRAVITY_CURRENT: +@WNCK_WINDOW_GRAVITY_NORTHWEST: +@WNCK_WINDOW_GRAVITY_NORTH: +@WNCK_WINDOW_GRAVITY_NORTHEAST: +@WNCK_WINDOW_GRAVITY_WEST: +@WNCK_WINDOW_GRAVITY_CENTER: +@WNCK_WINDOW_GRAVITY_EAST: +@WNCK_WINDOW_GRAVITY_SOUTHWEST: +@WNCK_WINDOW_GRAVITY_SOUTH: +@WNCK_WINDOW_GRAVITY_SOUTHEAST: +@WNCK_WINDOW_GRAVITY_STATIC: -<!-- ##### FUNCTION wnck_window_unmaximize_horizontally ##### --> +<!-- ##### ENUM WnckWindowMoveResizeMask ##### --> <para> </para> -@window: - +@WNCK_WINDOW_CHANGE_X: +@WNCK_WINDOW_CHANGE_Y: +@WNCK_WINDOW_CHANGE_WIDTH: +@WNCK_WINDOW_CHANGE_HEIGHT: -<!-- ##### FUNCTION wnck_window_maximize_vertically ##### --> +<!-- ##### FUNCTION wnck_window_get_geometry ##### --> <para> </para> @window: +@xp: +@yp: +@widthp: +@heightp: -<!-- ##### FUNCTION wnck_window_unmaximize_vertically ##### --> +<!-- ##### FUNCTION wnck_window_set_geometry ##### --> <para> </para> @window: +@gravity: +@geometry_mask: +@x: +@y: +@width: +@height: <!-- ##### FUNCTION wnck_window_keyboard_move ##### --> |