Asks the window manager to make window the active window. The
window manager may choose to raise window along with focusing it, and may
decide to refuse the request (to not steal the focus if there is a more
recent user activity, for example).
This function existed before 2.10, but the timestamp argument was missing
in earlier versions.
the X server timestamp of the user interaction event that caused this call to occur.
If window has transients, activates the most likely transient
instead of the window itself. Otherwise activates window.
FIXME the ideal behavior of this function is probably to activate
the most recently active window among window and its transients.
This is probably best implemented on the window manager side.
This function existed before 2.10, but the timestamp argument was missing
in earlier versions.
the X server timestamp of the user interaction event that caused this call to occur.
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
Closes window.
This function existed before 2.6, but the timestamp argument was missing
in earlier versions.
the X server timestamp of the user interaction event that caused this call to occur.
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets the actions that can be done for window.
Gets the #WnckApplication to which window belongs.
Gets the #WnckClassGroup to which window belongs.
Gets the class group name from the window.
The class group name is also the identifier name of the #WnckClassGroup to
which window belongs.
Gets the class instance name from the window.
The class instance name allows to differentiate windows belonging to the same class group, so that they can use different resources.
Gets the size and position of window, as last received
in a ConfigureNotify event (i.e. this call does not round-trip
to the server, just gets the last size we were notified of).
The X and Y coordinates are relative to the root window.
The window manager usually adds a frame around windows. If
you need to know the size of window with the frame, use
wnck_window_get_geometry().
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Gets the size and position of window, including decorations. This
function uses the information last received in a ConfigureNotify
event and adjusts it according to the size of the frame that is
added by the window manager (this call does not round-trip to the
server, it just gets the last sizes that were notified). The
X and Y coordinates are relative to the root window.
If you need to know the actual size of window ignoring the frame
added by the window manager, use wnck_window_get_client_window_geometry().
Gets the group leader of the group of windows to which window belongs.
Gets the icon to be used for window. If no icon was found, a fallback
icon is used. wnck_window_get_icon_is_fallback() can be used to tell if the
icon is the fallback icon.
Gets whether a default fallback icon is used for window (because none
was set on window).
Gets the icon name of window, as it should be displayed for an icon
(minimized state). Always returns some value, even if window has no icon
name set; use wnck_window_has_icon_name() if you need to know whether the
returned icon name is "real" or not.
Contrast with wnck_window_get_name(), which returns window<!-- -->'s
title, not its icon title.
Gets the mini-icon to be used for window. If no mini-icon was found, a
fallback mini-icon is used. wnck_window_get_icon_is_fallback() can be used
to tell if the mini-icon is the fallback mini-icon.
Gets the name of window, as it should be displayed in a pager
or tasklist. Always returns some value, even if window has no name
set; use wnck_window_has_name() if you need to know whether the returned
name is "real" or not.
For icons titles, use wnck_window_get_icon_name() instead.
Gets the process ID of window.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Gets the role for window.
The role uniquely identifies a window among all windows that have the same
client leader window.
Gets the session ID for window in Latin-1 encoding.
NOTE: this is invalid UTF-8. You can't display this
string in a GTK+ widget without converting to UTF-8.
See wnck_window_get_session_id_utf8().
Gets the session ID for window in UTF-8 encoding.
The session ID should be in Latin-1 encoding, so the conversion should work,
but a broken client could set a session ID that might not be convertable to
UTF-8.
Gets the sort order of window, used for ordering of window in
#WnckSelector and #WnckTasklist. The sort order is an internal state in
libwnck. The initial value is defined when the window is created.
Gets the state of window.
Gets the semantic type of window.
Gets the current workspace window is on. If the window is pinned (on all
workspaces), or not on any workspaces, %NULL may be returned.
Gets the X window ID of window.
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether or not window has an icon name.
wnck_window_get_icon_name() will always return some value, even if
window has no icon name set; wnck_window_has_icon_name() can
be used to tell if that icon name is real or not.
(Note that if wnck_window_has_icon_name() returns %FALSE, but
wnck_window_has_name() returns %TRUE, then the name returned by
wnck_window_get_icon_name() is window<!-- -->'s name. Only when both
methods return %FALSE does wnck_window_get_icon_name() return a
generic fallback name.)
Checks whether or not window has a name. wnck_window_get_name()
will always return some value, even if window has no name set;
wnck_window_has_name() can be used to tell if that name is
real or not.
For icons titles, use wnck_window_has_icon_name() instead.
Gets whether window is above other windows. This state may change
anytime a #WnckWindow::state-changed signal gets emitted.
See wnck_window_make_above() for more details on this state.
Gets whether window is the active window on its #WnckScreen.
Gets whether window is below other windows. This state may change
anytime a #WnckWindow::state-changed signal gets emitted.
See wnck_window_make_below() for more details on this state.
Checks whether object has a [floating][floating-ref] reference.
Gets whether window is fullscreen. Fullscreen state may change
anytime a #WnckWindow::state-changed signal gets emitted.
Gets %TRUE if window appears in the current viewport of workspace.
a #WnckWorkspace.
Gets whether window is maximized. Maximization state may change
anytime a #WnckWindow::state-changed signal gets emitted.
As for GDK, "maximized" means both vertically and horizontally. If window
is maximized in only one direction, then window is not considered
maximized.
Gets whether window is maximized horizontally. Horizontal maximization
state may change anytime a #WnckWindow::state-changed signal gets emitted.
Gets whether window is maximized vertically. vertiVal maximization
state may change anytime a #WnckWindow::state-changed signal gets emitted.
Gets whether window is minimized. Minimization state may change anytime
a #WnckWindow::state-changed signal gets emitted.
Gets whether window is the most recently activated window on its
#WnckScreen.
The most recently activated window is identical to the active window for click and sloppy focus methods (since a window is always active in those cases) but differs slightly for mouse focus since there often is no active window.
Gets whether window appears on workspace.
a #WnckWorkspace.
Gets whether window is on all workspace. Pinned state may change
anytime a #WnckWindow::workspace-changed signal gets emitted, but not when
a #WnckWindow::state-changed gets emitted.
Gets whether window is shaded. Shade state may change anytime
a #WnckWindow::state-changed signal gets emitted.
Gets whether window is included on pagers. This state may change
anytime a #WnckWindow::state-changed signal gets emitted.
Gets whether window is included on tasklists. This state may change
anytime a #WnckWindow::state-changed signal gets emitted.
Gets whether window is sticky. Sticky state may change
anytime a #WnckWindow::state-changed signal gets emitted.
Sticky here means "stuck to the glass", i.e. does not scroll with the
viewport. In GDK/GTK+ (e.g. gdk_window_stick()/gtk_window_stick()), sticky
means "stuck to the glass" and
Like wnck_window_is_on_workspace(), but also checks that the window is in a visible state (i.e. not minimized or shaded).
a #WnckWorkspace.
Asks the window manager to start moving window via the keyboard.
Asks the window manager to start resizing window via the keyboard.
Asks the window manager to put window on top of most windows (window will
not be on top of focused fullscreen windows, of other windows with this
setting and of dock windows).
Asks the window manager to put window below most windows.
Asks the window manager to maximize window.
Asks the window manager to maximize horizontally window.
Asks the window manager to maximize vertically window.
Minimizes window.
Asks the window manager to move window to space. If window was pinned, it
will also result in window being visible only on space.
a #WnckWorkspace.
Gets whether window needs attention. This state may change anytime
a #WnckWindow::state-changed signal gets emitted.
This state depends on flags such as the demands_attention and is_urgent hints.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object.
Gets whether window or one of its transients needs attention. This state
may change anytime a #WnckWindow::state-changed signal gets emitted.
Asks the window manager to put window on all workspaces.
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a #GQuark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Asks the window manager to set the fullscreen state of window according to
fullscreen.
whether to make window fullscreen.
Sets the size and position of window. The X and Y coordinates should be
relative to the root window.
Note that the new size and position apply to window with its frame added
by the window manager. Therefore, using wnck_window_set_geometry() with
the values returned by wnck_window_get_geometry() should be a no-op, while
using wnck_window_set_geometry() with the values returned by
wnck_window_get_client_window_geometry() should reduce the size of window
and move it.
the gravity point to use as a reference for the new position.
a bitmask containing flags for what should be set.
new X coordinate in pixels of window.
new Y coordinate in pixels of window.
new width in pixels of window.
new height in pixels of window.
Sets the icon geometry for window. A typical use case for this is the
destination of the minimization animation of window.
X coordinate in pixels.
Y coordinate in pixels.
width in pixels.
height in pixels.
Sets a property on an object.
the name of the property to set
the value
Asks the window manager to make window included or not included on pagers.
whether window should be included on pagers.
Asks the window manager to make window included or not included on
tasklists.
whether window should be included on tasklists.
Sets the sort order of window. The sort order is used for ordering of
window in #WnckSelector and #WnckTasklist.
new sort order for window.
Sets the semantic type of window to wintype.
a semantic type.
Asks the window manager to shade window.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Asks the window manager to keep the window<!-- -->'s position fixed on the
screen, even when the workspace or viewport scrolls.
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Gets whether one of the transients of window is the most
recently activated window. See
wnck_window_is_most_recently_activated() for a more complete
description of what is meant by most recently activated. This
function is needed because clicking on a #WnckTasklist once will
activate a transient instead of window itself
(wnck_window_activate_transient), and clicking again should
minimize window and its transients. (Not doing this can be
especially annoying in the case of modal dialogs that don't appear
in the #WnckTasklist).
Asks the window manager to not put window on top of most windows, and to
put it again in the stack with other windows.
Asks the window manager to not put window below most windows, and to
put it again in the stack with other windows.
Asks the window manager to unmaximize window.
Asks the window manager to unmaximize horizontally window.
Asks the window manager to unmaximize vertically window.
Unminimizes window by activating it or one of its transients. See
wnck_window_activate_transient() for details on how the activation is done.
the X server timestamp of the user interaction event that caused this call to occur.
Asks the window manager to put window only in the currently active
workspace, if window was previously pinned. If window was not pinned,
does not change window<!-- -->'s workspace. If the active workspace
is not known for some reason (it should not happen much), sets
window<!-- -->'s workspace to the first workspace.
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
Asks the window manager to unshade window.
Asks the window manager to not have window<!-- -->'s position fixed on the
screen when the workspace or viewport scrolls.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
#GTypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
The #WnckWindow struct contains only private fields and should not be directly accessed.