![]() |
![]() |
![]() |
Mx Toolkit Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
struct MxWindow; struct MxWindowClass; 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
); void mx_window_set_toolbar (MxWindow *window
,MxToolbar *toolbar
); 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
); gboolean mx_window_get_fullscreen (MxWindow *window
); void mx_window_set_fullscreen (MxWindow *window
,gboolean fullscreen
); void mx_window_set_title (MxWindow *window
,const gchar *title
); const gchar * mx_window_get_title (MxWindow *window
); void mx_window_set_icon_name (MxWindow *window
,const gchar *icon_name
); const gchar * mx_window_get_icon_name (MxWindow *window
); void mx_window_set_icon_from_cogl_texture (MxWindow *window
,CoglHandle texture
); ClutterStage * mx_window_get_clutter_stage (MxWindow *window
); 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_get_window_size (MxWindow *window
,gint *width
,gint *height
); void mx_window_set_window_size (MxWindow *window
,gint width
,gint height
); void mx_window_present (MxWindow *window
); void mx_window_set_window_rotation (MxWindow *window
,MxWindowRotation rotation
); MxWindowRotation mx_window_get_window_rotation (MxWindow *window
); void mx_window_show (MxWindow *window
); void mx_window_hide (MxWindow *window
);
"child" ClutterActor* : Read / Write "clutter-stage" ClutterStage* : Read / Write / Construct Only "fullscreen" gboolean : Read / Write "has-toolbar" gboolean : Read / Write "icon-cogl-texture" gchar* : Read / Write "icon-name" gchar* : Read / Write "small-screen" gboolean : Read / Write "title" gchar* : Read / Write "toolbar" MxToolbar* : Read / Write "window-rotation" MxWindowRotation : Read / Write "window-rotation-angle" gfloat : Read "window-rotation-timeline" ClutterTimeline* : Read
MxWindow is a platform-specific window, providing functions for moving, resizing, icons and rotation. Every window has an associated ClutterStage in which its children are kept. This ClutterStage can be used in the normal way, but to take advantage of automatic resizing and rotation, the MxWindow functions should be used.
When the MxWindow loses its last reference, its contents are destroyed.
struct MxWindow;
The contents of this structure is private and should only be accessed using the provided API.
struct MxWindowClass { GObjectClass parent_class; /* signals, not vfuncs */ void (*destroy) (MxWindow *window); /* padding for future expansion */ void (*_padding_0) (void); void (*_padding_1) (void); void (*_padding_2) (void); void (*_padding_3) (void); void (*_padding_4) (void); };
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.
|
A ClutterStage |
Returns : |
A MxWindow |
MxWindow * mx_window_get_for_stage (ClutterStage *stage
);
Gets the MxWindow parent of the ClutterStage, if it exists.
|
A ClutterStage |
Returns : |
A MxWindow, or NULL . [transfer none]
|
ClutterActor * mx_window_get_child (MxWindow *window
);
Get the primary child of the window. See mx_window_set_child()
.
|
A MxWindow |
Returns : |
A ClutterActor, or NULL . [transfer none]
|
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.
|
A MxWindow |
|
A ClutterActor |
MxToolbar * mx_window_get_toolbar (MxWindow *window
);
Retrieves the toolbar associated with the window.
void mx_window_set_toolbar (MxWindow *window
,MxToolbar *toolbar
);
Sets the toolbar associated with the window.
|
A MxWindow. [allow-none] |
Since 1.2
gboolean mx_window_get_has_toolbar (MxWindow *window
);
Determines whether the window has a toolbar or not.
See mx_window_set_has_toolbar()
.
|
A MxWindow |
Returns : |
TRUE if the window has a toolbar, otherwise FALSE
|
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.
|
A MxWindow |
|
TRUE if the toolbar should be displayed |
gboolean mx_window_get_small_screen (MxWindow *window
);
Determines if the window is in small-screen mode.
See mx_window_set_small_screen()
.
|
A MxWindow |
Returns : |
TRUE if the window is in small-screen mode, otherwise FALSE
|
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.
|
A MxWindow |
|
TRUE if small-screen mode should be enabled |
gboolean mx_window_get_fullscreen (MxWindow *window
);
Determines if the window has been set to be in fullscreen mode.
|
A MxWindow |
Returns : |
TRUE if the window has been set to be in fullscreen mode,
otherwise FALSE
|
Since 1.2
void mx_window_set_fullscreen (MxWindow *window
,gboolean fullscreen
);
Set the window to be in fullscreen mode or windowed mode.
Setting fullscreen mode doesn't necessarily mean the window is actually fullscreen. Setting this property is only a request to the underlying window system.
|
A MxWindow |
|
TRUE to request fullscreen mode, FALSE to disable |
Since 1.2
void mx_window_set_title (MxWindow *window
,const gchar *title
);
Sets the title used for the window, the results of which are window-system specific.
|
A MxWindow |
|
A string to use for the window title name |
Since 1.2
const gchar * mx_window_get_title (MxWindow *window
);
Retrieves the title used for the window.
|
A MxWindow |
Returns : |
The title used for the window |
Since 1.2
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.
|
A MxWindow |
|
An icon name, or NULL . [allow-none]
|
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()
.
|
A MxWindow |
Returns : |
The window icon name, or NULL
|
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.
|
A MxWindow |
|
A CoglHandle for a texture |
ClutterStage * mx_window_get_clutter_stage (MxWindow *window
);
Gets the ClutterStage managed by the window.
|
A MxWindow |
Returns : |
A ClutterStage. [transfer none] |
void mx_window_get_window_position (MxWindow *window
,gint *x
,gint *y
);
Retrieves the absolute position of the window on the screen.
|
an MxWindow |
|
A pointer for the x-coordinate. [out] |
|
A pointer for the y-coordinate. [out] |
void mx_window_set_window_position (MxWindow *window
,gint x
,gint y
);
Sets the absolute position of the window on the screen.
|
A MxWindow |
|
An x-coordinate |
|
A y-coordinate |
void mx_window_get_window_size (MxWindow *window
,gint *width
,gint *height
);
Retrieves the size of the display area of the window, taking into account any window border. This includes the area occupied by the window's toolbar, if it's enabled.
|
A MxWindow |
|
A gint pointer for the window's width. [out] |
|
A gint pointer for the window's height. [out] |
Since 1.2
void mx_window_set_window_size (MxWindow *window
,gint width
,gint height
);
Sets the size of the window, taking into account any window border. This corresponds to the window's available area for its child, minus the area occupied by the window's toolbar, if it's enabled.
Setting the window size may involve a request to the underlying windowing system, and may not immediately be reflected.
|
A MxWindow |
|
A width, in pixels |
|
A height, in pixels |
Since 1.2
void mx_window_present (MxWindow *window
);
Present the window. The actual behaviour is specific to the window system.
|
A MxWindow |
Since 1.2
void mx_window_set_window_rotation (MxWindow *window
,MxWindowRotation rotation
);
Set the rotation of the window.
|
A MxWindow |
|
The MxWindowRotation |
Since 1.2
MxWindowRotation mx_window_get_window_rotation (MxWindow *window
);
Retrieve the rotation of the window.
|
A MxWindow |
Returns : |
An MxWindowRotation |
Since 1.2
void mx_window_show (MxWindow *window
);
Show the window
|
A MxWindow |
Since 1.2
"clutter-stage"
property "clutter-stage" ClutterStage* : Read / Write / Construct Only
ClutterStage to use as the window.
"fullscreen"
property "fullscreen" gboolean : Read / Write
Window should be set to full-screen mode.
Default value: FALSE
"has-toolbar"
property "has-toolbar" gboolean : Read / Write
Window should have a toolbar.
Default value: TRUE
"icon-cogl-texture"
property "icon-cogl-texture" gchar* : Read / Write
CoglTexture to use for the window icon.
Default value: NULL
"icon-name"
property "icon-name" gchar* : Read / Write
Icon name to use for the window icon.
Default value: NULL
"small-screen"
property "small-screen" gboolean : Read / Write
Window should occupy the entire screen contents, without explicitly setting itself fullscreen.
Default value: FALSE
"toolbar"
property"toolbar" MxToolbar* : Read / Write
The MxToolbar associated with the window.
"window-rotation"
property"window-rotation" MxWindowRotation : Read / Write
The window's rotation.
Default value: MX_WINDOW_ROTATION_0
"window-rotation-angle"
property "window-rotation-angle" gfloat : Read
The current angle of rotation about the z-axis for the window.
Allowed values: [0,360]
Default value: 0
"destroy"
signalvoid user_function (MxWindow *window,
gpointer user_data) : Run Last
Emitted when the stage managed by the window is destroyed.
|
the object that received the signal |
|
user data set when the signal handler was connected. |