MxWindow

## MxWindow MxWindow |

## Synopsis

    struct              MxWindow;
    MxWindow *          mx_window_new                       (void);
    MxWindow *          mx_window_new_with_clutter_stage    (ClutterStage *stage);
    MxWindow *          mx_window_get_for_stage             (ClutterStage *stage);
    ClutterActor *      mx_window_get_child                 (MxWindow *window);
    void                mx_window_set_child                 (MxWindow *window,
                                                             ClutterActor *actor);
    MxToolbar *         mx_window_get_toolbar               (MxWindow *window);
    gboolean            mx_window_get_has_toolbar           (MxWindow *window);
    void                mx_window_set_has_toolbar           (MxWindow *window,
                                                             gboolean toolbar);
    gboolean            mx_window_get_small_screen          (MxWindow *window);
    void                mx_window_set_small_screen          (MxWindow *window,
                                                             gboolean small_screen);
    void                mx_window_get_window_position       (MxWindow *window,
                                                             gint *x,
                                                             gint *y);
    void                mx_window_set_window_position       (MxWindow *window,
                                                             gint x,
                                                             gint y);
    void                mx_window_set_icon_name             (MxWindow *window,
                                                             const gchar *icon_name);
    void                mx_window_set_icon_from_cogl_texture
                                                            (MxWindow *window,
                                                             CoglHandle texture);
    const gchar *       mx_window_get_icon_name             (MxWindow *window);
    ClutterStage *      mx_window_get_clutter_stage         (MxWindow *window);

## Object Hierarchy

      GObject
       +----MxWindow

## Properties

      "child"                    ClutterActor*         : Read / Write
      "clutter-stage"            ClutterStage*         : Read / Write / Construct Only
      "has-toolbar"              gboolean              : Read / Write
      "icon-cogl-texture"        gchar*                : Write
      "icon-name"                gchar*                : Read / Write
      "small-screen"             gboolean              : Read / Write
      "toolbar"                  MxToolbar*            : Read

## Signals

      "destroy"                                        : Run Last

## Description

## Details

### struct MxWindow

    struct MxWindow;

The contents of this structure is private and should only be accessed using the provided API.

### mx_window_new ()

    MxWindow *          mx_window_new                       (void);

Creates a new MxWindow.

Returns : | A MxWindow

### mx_window_new_with_clutter_stage ()

    MxWindow *          mx_window_new_with_clutter_stage    (ClutterStage *stage);

Creates a new MxWindow, using `stage` as the backing ClutterStage. This function is meant for use primarily for embedding a MxWindow into a foreign stage when using a Clutter toolkit integration library.

`stage` : | A ClutterStage
Returns : | A MxWindow

### mx_window_get_for_stage ()

    MxWindow *          mx_window_get_for_stage             (ClutterStage *stage);

Gets the MxWindow parent of the ClutterStage, if it exists.

`stage` : | A ClutterStage
Returns : | A MxWindow, or `NULL`

### mx_window_get_child ()

    ClutterActor *      mx_window_get_child                 (MxWindow *window);

Get the primary child of the window. See `mx_window_set_child()`.

`window` : | A MxWindow
Returns : | A ClutterActor, or `NULL`

### mx_window_set_child ()

    void                mx_window_set_child                 (MxWindow *window,
                                                             ClutterActor *actor);

Adds `actor` to the window and sets it as the primary child. When the stage managed in the window changes size, the child will be resized to match it.

`window` : | A MxWindow
`actor` : | A ClutterActor

### mx_window_get_toolbar ()

    MxToolbar *         mx_window_get_toolbar               (MxWindow *window);

Retrieves the toolbar associated with the window.

`window` : | A MxWindow
Returns : | A MxToolbar

### mx_window_get_has_toolbar ()

    gboolean            mx_window_get_has_toolbar           (MxWindow *window);

Determines whether the window has a toolbar or not. See `mx_window_set_has_toolbar()`.

`window` : | A MxWindow
Returns : | `TRUE` if the window has a toolbar, otherwise `FALSE`

### mx_window_set_has_toolbar ()

    void                mx_window_set_has_toolbar           (MxWindow *window,
                                                             gboolean toolbar);

Sets whether the window has a toolbar or not. If the window has a toolbar, client-side window decorations will be enabled.

`window` : | A MxWindow
`toolbar` : | `TRUE` if the toolbar should be displayed

### mx_window_get_small_screen ()

    gboolean            mx_window_get_small_screen          (MxWindow *window);

Determines if the window is in small-screen mode. See `mx_window_set_small_screen()`.

`window` : | A MxWindow
Returns : | `TRUE` if the window is in small-screen mode, otherwise `FALSE`

### mx_window_set_small_screen ()

    void                mx_window_set_small_screen          (MxWindow *window,
                                                             gboolean small_screen);

Enables or disables small-screen mode. This mode is meant primarily for platforms with limited screen-space, such as netbooks. When enabled, the window will take up all available room and will disable moving and resizing.

`window` : | A MxWindow
`small_screen` : | `TRUE` if small-screen mode should be enabled

### mx_window_get_window_position ()

    void                mx_window_get_window_position       (MxWindow *window,
                                                             gint *x,
                                                             gint *y);

Retrieves the absolute position of the window on the screen.

`window` : | an MxWindow
`x` : | A pointer for the x-coordinate. [out]
`y` : | A pointer for the y-coordinate. [out]

### mx_window_set_window_position ()

    void                mx_window_set_window_position       (MxWindow *window,
                                                             gint x,
                                                             gint y);

Sets the absolute position of the window on the screen.

`window` : | A MxWindow
`x` : | An x-coordinate
`y` : | A y-coordinate

### mx_window_set_icon_name ()

    void                mx_window_set_icon_name             (MxWindow *window,
                                                             const gchar *icon_name);

Set an icon-name to use for the window icon. The icon will be looked up from the default theme.

`window` : | A MxWindow
`icon_name` : | An icon name, or `NULL`. [allow-none]

### mx_window_set_icon_from_cogl_texture ()

    void                mx_window_set_icon_from_cogl_texture
                                                            (MxWindow *window,
                                                             CoglHandle texture);

Sets the window icon from a texture. This will take precedence over any currently set icon-name.

`window` : | A MxWindow
`texture` : | A CoglHandle for a texture

### mx_window_get_icon_name ()

    const gchar *       mx_window_get_icon_name             (MxWindow *window);

Gets the currently set window icon name. This will be `NULL` if there is none set, or the icon was set with `mx_window_set_icon_from_cogl_texture()`.

`window` : | A MxWindow
Returns : | The window icon name, or `NULL`

### mx_window_get_clutter_stage ()

    ClutterStage *      mx_window_get_clutter_stage         (MxWindow *window);

Gets the ClutterStage managed by the window.

`window` : | A MxWindow
Returns : | A ClutterStage

## Property Details

### The `"child"` property

      "child"                    ClutterActor*         : Read / Write

ClutterActor used as the window child.

### The `"clutter-stage"` property

      "clutter-stage"            ClutterStage*         : Read / Write / Construct Only

ClutterStage to use as the window.

### The `"has-toolbar"` property

      "has-toolbar"              gboolean              : Read / Write

Window should have a toolbar.

Default value: TRUE

### The `"icon-cogl-texture"` property

      "icon-cogl-texture"        gchar*                : Write

CoglTexture to use for the window icon.

Default value: NULL

### The `"icon-name"` property

      "icon-name"                gchar*                : Read / Write

Icon name to use for the window icon.

Default value: NULL

### The `"small-screen"` property

      "small-screen"             gboolean              : Read / Write

Window should occupy the entire screen contents, without explicitly setting itself fullscreen.

Default value: FALSE

### The `"toolbar"` property

      "toolbar"                  MxToolbar*            : Read

The MxToolbar associated with the window.

## Signal Details

### The `"destroy"` signal

    void                user_function                      (MxWindow *window,
                                                            gpointer  user_data)      : Run Last

Emitted when the stage managed by the window is destroyed.

`window` : | the object that received the signal
`user_data` : | user data set when the signal handler was connected.