Etk
Main Page Object Hierarchy Data Structures Related Pages
Etk

Etk_Mdi_Window


Detailed Description

A widget in a mdi area.

mdi_window.png

Object Hierarchy:
  • Etk_Object
    • Etk_Widget
      • Etk_Container
        • Etk_Bin
          • Etk_Mdi_Window
Properties:
  • "title": The title of the mdi_window
    • Type: String (char *)
    • Access: Read/Write
    • Default Value: NULL
  • "maximized": Whether or not the mdi_window is maximized
    • Type: Boolean
    • Access: Read/Write
    • Default Value: ETK_FALSE
  • "draggable": Whether or not the mdi_window is draggable
    • Type: Boolean
    • Access: Read/Write
    • Default Value: ETK_TRUE
  • "resizable": Whether or not the mdi_window is resizable
    • Type: Boolean
    • Access: Read/Write
    • Default Value: ETK_TRUE
  • "decorated": Whether or not the mdi_window is decorated
    • Type: Boolean
    • Access: Read/Write
    • Default Value: ETK_TRUE


Data Structures

struct  Etk_Mdi_Window
 [Widget] A widget in a mdi area More...

Defines

#define ETK_MDI_WINDOW_TYPE   (etk_mdi_window_type_get())
#define ETK_MDI_WINDOW(obj)   (ETK_OBJECT_CAST((obj), ETK_MDI_WINDOW_TYPE, Etk_Mdi_Window))
#define ETK_IS_MDI_WINDOW(obj)   (ETK_OBJECT_CHECK_TYPE((obj), ETK_MDI_WINDOW_TYPE))

Functions

Etk_Widget * etk_mdi_window_new (void)
 Creates a new mdi_window.
void etk_mdi_window_delete_request (Etk_Mdi_Window *mdi_window)
 Emits a delete-request on the mdi_window: it will call all the callbacks connected to the "delete-event" signal and if all these callbacks return ETK_TRUE, the mdi_window will be destroyed. It has the same effect as if the user had clicked on the "close" button of the mdi_window.
void etk_mdi_window_title_set (Etk_Mdi_Window *mdi_window, const char *title)
 Sets the title of the mdi_window.
const char * etk_mdi_window_title_get (Etk_Mdi_Window *mdi_window)
 Gets the title of the mdi_window.
void etk_mdi_window_move (Etk_Mdi_Window *mdi_window, int x, int y)
 Moves a mdi_window to the position (x, y).
void etk_mdi_window_maximized_set (Etk_Mdi_Window *mdi_window, Etk_Bool maximized)
 Sets whether or not the mdi_window is maximized.
Etk_Bool etk_mdi_window_maximized_get (Etk_Mdi_Window *mdi_window)
 Gets whether the mdi_window is maximized.
void etk_mdi_window_draggable_set (Etk_Mdi_Window *mdi_window, Etk_Bool draggable)
 Sets whether or not the mdi_window is draggable.
Etk_Bool etk_mdi_window_draggable_get (Etk_Mdi_Window *mdi_window)
 Gets whether the mdi_window is draggable.
void etk_mdi_window_resizable_set (Etk_Mdi_Window *mdi_window, Etk_Bool resizable)
 Sets whether or not the mdi_window is draggable.
Etk_Bool etk_mdi_window_resizable_get (Etk_Mdi_Window *mdi_window)
 Gets whether the mdi_window is resizable.
void etk_mdi_window_decorated_set (Etk_Mdi_Window *mdi_window, Etk_Bool decorated)
 Sets whether or not the mdi_window is decorated.
Etk_Bool etk_mdi_window_decorated_get (Etk_Mdi_Window *mdi_window)
 Gets whether the mdi_window is decorated.
Etk_Bool etk_mdi_window_hide_on_delete (Etk_Object *mdi_window, void *data)
 A utility function to use as a callback for the "delete-event" signal. It will hide the mdi_window and return ETK_TRUE to prevent the program from quitting.


Define Documentation

#define ETK_MDI_WINDOW_TYPE   (etk_mdi_window_type_get())

Gets the type of a mdi_window

Referenced by etk_mdi_window_new().

#define ETK_MDI_WINDOW ( obj   )     (ETK_OBJECT_CAST((obj), ETK_MDI_WINDOW_TYPE, Etk_Mdi_Window))

Casts the object to an Etk_Mdi_Window

#define ETK_IS_MDI_WINDOW ( obj   )     (ETK_OBJECT_CHECK_TYPE((obj), ETK_MDI_WINDOW_TYPE))

Check if the object is an Etk_Mdi_Window

Referenced by etk_mdi_area_put().


Function Documentation

Etk_Widget * etk_mdi_window_new ( void   ) 

Creates a new mdi_window.

Returns:
Returns the new mdi_window widget

References ETK_MDI_WINDOW_TYPE, and etk_widget_new().

void etk_mdi_window_delete_request ( Etk_Mdi_Window *  mdi_window  ) 

Emits a delete-request on the mdi_window: it will call all the callbacks connected to the "delete-event" signal and if all these callbacks return ETK_TRUE, the mdi_window will be destroyed. It has the same effect as if the user had clicked on the "close" button of the mdi_window.

Parameters:
mdi_window a mdi_window

References ETK_OBJECT, etk_object_destroy(), etk_signal_emit(), ETK_WIDGET, and etk_widget_parent_set().

void etk_mdi_window_title_set ( Etk_Mdi_Window *  mdi_window,
const char *  title 
)

Sets the title of the mdi_window.

Parameters:
mdi_window a mdi_window
title the title to set

References ETK_OBJECT, etk_object_notify(), ETK_WIDGET, etk_widget_theme_part_text_set(), and title.

const char * etk_mdi_window_title_get ( Etk_Mdi_Window *  mdi_window  ) 

Gets the title of the mdi_window.

Parameters:
mdi_window a mdi_window
Returns:
Returns the title of the mdi_window

References title.

void etk_mdi_window_move ( Etk_Mdi_Window *  mdi_window,
int  x,
int  y 
)

Moves a mdi_window to the position (x, y).

Parameters:
mdi_window a mdi_window
x the x position where to move the mdi_window
y the y position where to move the mdi_window

References ETK_OBJECT, and etk_signal_emit().

void etk_mdi_window_maximized_set ( Etk_Mdi_Window *  mdi_window,
Etk_Bool  maximized 
)

Sets whether or not the mdi_window is maximized.

Parameters:
mdi_window a mdi_window
maximized ETK_TRUE to maximize the mdi_window, ETK_FALSE to unmaximize it

References ETK_OBJECT, etk_object_notify(), and maximized.

Etk_Bool etk_mdi_window_maximized_get ( Etk_Mdi_Window *  mdi_window  ) 

Gets whether the mdi_window is maximized.

Parameters:
mdi_window a mdi_window
Returns:
Returns ETK_TRUE if the mdi_window is maximized, ETK_FALSE otherwise

References maximized.

void etk_mdi_window_draggable_set ( Etk_Mdi_Window *  mdi_window,
Etk_Bool  draggable 
)

Sets whether or not the mdi_window is draggable.

Parameters:
mdi_window a mdi_window
draggable ETK_TRUE to enable drag on the mdi_window, ETK_FALSE otherwise

References draggable, dragging, ETK_OBJECT, and etk_object_notify().

Etk_Bool etk_mdi_window_draggable_get ( Etk_Mdi_Window *  mdi_window  ) 

Gets whether the mdi_window is draggable.

Parameters:
mdi_window a mdi_window
Returns:
Returns ETK_TRUE if the mdi_window is draggable, ETK_FALSE otherwise

References draggable.

void etk_mdi_window_resizable_set ( Etk_Mdi_Window *  mdi_window,
Etk_Bool  resizable 
)

Sets whether or not the mdi_window is draggable.

Parameters:
mdi_window a mdi_window
resizable ETK_TRUE to enable resize on the mdi_window, ETK_FALSE otherwise

References ETK_OBJECT, etk_object_notify(), resizable, and resizing.

Etk_Bool etk_mdi_window_resizable_get ( Etk_Mdi_Window *  mdi_window  ) 

Gets whether the mdi_window is resizable.

Parameters:
mdi_window a mdi_window
Returns:
Returns ETK_TRUE if the mdi_window is resizable, ETK_FALSE otherwise

References resizable.

void etk_mdi_window_decorated_set ( Etk_Mdi_Window *  mdi_window,
Etk_Bool  decorated 
)

Sets whether or not the mdi_window is decorated.

Parameters:
mdi_window a mdi_window
decorated ETK_TRUE to enable decoration on the mdi_window, ETK_FALSE otherwise

References decorated, ETK_OBJECT, etk_object_notify(), ETK_WIDGET, and etk_widget_theme_group_set().

Etk_Bool etk_mdi_window_decorated_get ( Etk_Mdi_Window *  mdi_window  ) 

Gets whether the mdi_window is decorated.

Parameters:
mdi_window a mdi_window
Returns:
Returns ETK_TRUE if the mdi_window is decorated, ETK_FALSE otherwise

References decorated.

Etk_Bool etk_mdi_window_hide_on_delete ( Etk_Object *  mdi_window,
void *  data 
)

A utility function to use as a callback for the "delete-event" signal. It will hide the mdi_window and return ETK_TRUE to prevent the program from quitting.

Parameters:
mdi_window the mdi_window to hide
data the data passed when the signal is emitted - unused
Returns:
Return ETK_TRUE so the the program won't quit

References ETK_WIDGET, and etk_widget_hide().