Download

Support

Ewl_Separator: A Visual Separator Between Widgets


Detailed Description

Defines the Ewl_Separator class used for drawing lines between widgets when visual separation is needed.

Remarks:
Inherits from Ewl_Widget.


Data Structures

struct  Ewl_Separator
 Inherits from Ewl_Widget to allow drawing a horizontal or vertical line between widgets, depending on the orientation the Ewl_Separator. More...

Defines

#define EWL_SEPARATOR(separator)   ((Ewl_Separator *) separator)
#define EWL_SEPARATOR_IS(w)   (ewl_widget_type_is(EWL_WIDGET(w), EWL_SEPARATOR_TYPE))
#define EWL_SEPARATOR_TYPE   "separator"

Typedefs

typedef struct Ewl_Separator Ewl_Separator

Functions

Ewl_Widgetewl_hseparator_new (void)
 Allocate a new separator widget with horizontal orientation.
int ewl_separator_init (Ewl_Separator *s)
 Initialize the separator and inherited fields.
Ewl_Widgetewl_separator_new (void)
 Allocate a new separator widget with default (horizontal) orientation.
Ewl_Orientation ewl_separator_orientation_get (Ewl_Separator *s)
 This retrieves the current orientation of the separator.
void ewl_separator_orientation_set (Ewl_Separator *s, Ewl_Orientation o)
 Set the orientation of the separator.
Ewl_Widgetewl_vseparator_new (void)
 Allocate a new separator widget with vertical orientation.

Define Documentation

#define EWL_SEPARATOR_IS (  )     (ewl_widget_type_is(EWL_WIDGET(w), EWL_SEPARATOR_TYPE))

Returns TRUE if the widget is an Ewl_Separator, FALSE otherwise

#define EWL_SEPARATOR_TYPE   "separator"

Widget Theme Keys:
/hseparator/file
Widget Theme Keys:
/hseparator/group
Widget Theme Keys:
/vseparator/file
Widget Theme Keys:
/vseparator/group
The type name for the Ewl_Separator widget

Referenced by ewl_separator_init(), ewl_separator_orientation_get(), and ewl_separator_orientation_set().


Typedef Documentation

typedef struct Ewl_Separator Ewl_Separator

Provides an Ewl_Widget to simply act as a separator between other Ewl_Widget's.


Function Documentation

Ewl_Widget* ewl_hseparator_new ( void   ) 

Allocate a new separator widget with horizontal orientation.

Returns:
Returns pointer to new separator widget on success, NULL on failure.

References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_ORIENTATION_HORIZONTAL, EWL_SEPARATOR, ewl_separator_new(), ewl_separator_orientation_set(), and EWL_WIDGET.

Referenced by ewl_dialog_has_separator_set(), ewl_dialog_init(), and ewl_spectrum_init().

int ewl_separator_init ( Ewl_Separator s  ) 

Initialize the separator and inherited fields.

Parameters:
s,: the separator to initialize
Returns:
Returns TRUE on success, FALSE on failure. Clears the contents of the separator and stores the default values.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FLAG_ALIGN_LEFT, EWL_FLAG_FILL_HFILL, EWL_FLAG_FILL_SHRINK, EWL_OBJECT, ewl_object_alignment_set(), ewl_object_fill_policy_set(), EWL_ORIENTATION_HORIZONTAL, EWL_SEPARATOR_TYPE, EWL_WIDGET, ewl_widget_appearance_set(), ewl_widget_focusable_set(), ewl_widget_inherit(), ewl_widget_init(), and orientation.

Referenced by ewl_paned_grabber_init(), and ewl_separator_new().

Ewl_Widget* ewl_separator_new ( void   ) 

Allocate a new separator widget with default (horizontal) orientation.

Returns:
Returns pointer to new separator widget on success, NULL on failure.

References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, ewl_separator_init(), EWL_WIDGET, ewl_widget_destroy(), and NEW.

Referenced by ewl_hseparator_new(), and ewl_vseparator_new().

Ewl_Orientation ewl_separator_orientation_get ( Ewl_Separator s  ) 

This retrieves the current orientation of the separator.

Parameters:
s,: The separator to get the orientation from
Returns:
Returns the orientation currently set on the separator

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_ORIENTATION_HORIZONTAL, EWL_SEPARATOR_TYPE, and orientation.

Referenced by ewl_paned_grabber_orientation_get().

Ewl_Widget* ewl_vseparator_new ( void   ) 

Allocate a new separator widget with vertical orientation.

Returns:
Returns pointer to new separator widget on success, NULL on failure.

References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_ORIENTATION_VERTICAL, EWL_SEPARATOR, ewl_separator_new(), ewl_separator_orientation_set(), and EWL_WIDGET.

Referenced by ewl_spectrum_init().


Copyright © Enlightenment.org

Enlightened Widget Library Documentation Generated: Sat May 17 16:51:11 2008