Mutter Reference Manual: MetaWindowActor

MetaWindowActor

MetaWindowActor — An actor representing a top-level window in the scene graph

Synopsis

struct              MetaWindowActor;
struct              MetaWindowActorClass;
Window              meta_window_actor_get_x_window      (MetaWindowActor *self);
gint                meta_window_actor_get_workspace     (MetaWindowActor *self);
MetaWindow *        meta_window_actor_get_meta_window   (MetaWindowActor *self);
ClutterActor *      meta_window_actor_get_texture       (MetaWindowActor *self);
gboolean            meta_window_actor_is_override_redirect
                                                        (MetaWindowActor *self);
gboolean            meta_window_actor_showing_on_its_workspace
                                                        (MetaWindowActor *self);
gboolean            meta_window_actor_is_destroyed      (MetaWindowActor *self);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MetaWindowActor

Implemented Interfaces

MetaWindowActor implements ClutterContainer, ClutterScriptable, ClutterAnimatable and AtkImplementorIface.

Properties

  "meta-screen"              gpointer              : Read / Write / Construct
  "meta-window"              MetaWindow*           : Read / Write / Construct
  "no-shadow"                gboolean              : Read / Write
  "shadow-class"             gchar*                : Read / Write
  "x-window"                 gulong                : Read / Write / Construct

Signals

  "position-changed"                               : Run Last
  "size-changed"                                   : Run Last

Description

Details

struct MetaWindowActor

struct MetaWindowActor;

struct MetaWindowActorClass

struct MetaWindowActorClass {
};

meta_window_actor_get_x_window ()

Window              meta_window_actor_get_x_window      (MetaWindowActor *self);

self :

a MetaWindowActor

meta_window_actor_get_workspace ()

gint                meta_window_actor_get_workspace     (MetaWindowActor *self);

Returns the index of workspace on which this window is located; if the window is sticky, or is not currently located on any workspace, returns -1. This function is deprecated and should not be used in newly written code; meta_window_get_workspace() instead.

`self` :	MetaWindowActor
Returns :	index of workspace on which this window is located. [transfer none]

meta_window_actor_get_meta_window ()

MetaWindow *        meta_window_actor_get_meta_window   (MetaWindowActor *self);

Gets the MetaWindow object that the the MetaWindowActor is displaying

`self` :	a MetaWindowActor
Returns :	the displayed MetaWindow. [transfer none]

meta_window_actor_get_texture ()

ClutterActor *      meta_window_actor_get_texture       (MetaWindowActor *self);

Gets the ClutterActor that is used to display the contents of the window

`self` :	a MetaWindowActor
Returns :	the ClutterActor for the contents. [transfer none]

meta_window_actor_is_override_redirect ()

gboolean            meta_window_actor_is_override_redirect
                                                        (MetaWindowActor *self);

meta_window_actor_showing_on_its_workspace ()

gboolean            meta_window_actor_showing_on_its_workspace
                                                        (MetaWindowActor *self);

meta_window_actor_is_destroyed ()

gboolean            meta_window_actor_is_destroyed      (MetaWindowActor *self);

Gets whether the X window that the actor was displaying has been destroyed

`self` :	a MetaWindowActor
Returns :	`TRUE` when the window is destroyed, otherwise `FALSE`

Property Details

The `"meta-screen"` property

  "meta-screen"              gpointer              : Read / Write / Construct

MetaScreen.

The `"meta-window"` property

  "meta-window"              MetaWindow*           : Read / Write / Construct

The displayed MetaWindow.

The `"no-shadow"` property

  "no-shadow"                gboolean              : Read / Write

Do not add shaddow to this window.

Default value: FALSE

The `"shadow-class"` property

  "shadow-class"             gchar*                : Read / Write

NULL means to use the default shadow class for this window type.

Default value: NULL

The `"x-window"` property

  "x-window"                 gulong                : Read / Write / Construct

Window.

Signal Details

The `"position-changed"` signal

void                user_function                      (MetaWindowActor *metawindowactor,
                                                        gpointer         user_data)            : Run Last

The `"size-changed"` signal

void                user_function                      (MetaWindowActor *metawindowactor,
                                                        gpointer         user_data)            : Run Last