Etk
Main Page Object Hierarchy Data Structures Related Pages
Etk

Etk_Frame


Detailed Description

A frame is a bin container with a label. It may be useful to group widgets that are logically related.

frame.png

Object Hierarchy:
  • Etk_Object
    • Etk_Widget
      • Etk_Container
        • Etk_Bin
          • Etk_Frame
Properties:
  • "label": The text of the frame's label
    • Type: String (char *)
    • Access: Read/Write
    • Default Value: NULL


Data Structures

struct  Etk_Frame
 [Widget] A bin container with a label More...

Defines

#define ETK_FRAME_TYPE   (etk_frame_type_get())
#define ETK_FRAME(obj)   (ETK_OBJECT_CAST((obj), ETK_FRAME_TYPE, Etk_Frame))
#define ETK_IS_FRAME(obj)   (ETK_OBJECT_CHECK_TYPE((obj), ETK_FRAME_TYPE))

Functions

Etk_Widget * etk_frame_new (const char *label)
 Creates a new frame.
void etk_frame_label_set (Etk_Frame *frame, const char *label)
 Sets the label of the frame.
const char * etk_frame_label_get (Etk_Frame *frame)
 Gets the label of the frame.


Define Documentation

#define ETK_FRAME_TYPE   (etk_frame_type_get())

Gets the type of an frame

#define ETK_FRAME ( obj   )     (ETK_OBJECT_CAST((obj), ETK_FRAME_TYPE, Etk_Frame))

Casts the object to an Etk_Frame

#define ETK_IS_FRAME ( obj   )     (ETK_OBJECT_CHECK_TYPE((obj), ETK_FRAME_TYPE))

Checks if the object is an Etk_Frame


Function Documentation

Etk_Widget * etk_frame_new ( const char *  label  ) 

Creates a new frame.

Parameters:
label the label of the new frame
Returns:
Returns the new frame widget

void etk_frame_label_set ( Etk_Frame *  frame,
const char *  label 
)

Sets the label of the frame.

Parameters:
frame a frame
label the label to set

const char * etk_frame_label_get ( Etk_Frame *  frame  ) 

Gets the label of the frame.

Parameters:
frame a frame
Returns:
Returns the label of the frame