Download

Support

Ewl_Object: Base object. Provides functionality available to all widgets.


Detailed Description

Defines the Ewl_Object class along with basic methods and macros.

Tutorial


Data Structures

struct  Ewl_Object
 Provides facilities for sizing, position, alignment and fill policy. More...

Defines

#define CONFIGURED(o)
#define CURRENT_H(o)   ((const Ewl_Object *)(o))->current.h
#define CURRENT_W(o)   ((const Ewl_Object *)(o))->current.w
#define CURRENT_X(o)   ((const Ewl_Object *)(o))->current.x
#define CURRENT_Y(o)   ((const Ewl_Object *)(o))->current.y
#define DESTROYED(o)
#define DISABLED(o)   (ewl_object_state_has(EWL_OBJECT(o), EWL_FLAG_STATE_DISABLED))
#define EWL_OBJECT(object)   ((Ewl_Object *) object)
#define ewl_object_custom_h_set(o, h)
#define ewl_object_custom_size_set(o, w, h)
#define ewl_object_custom_w_set(o, w)
#define ewl_object_flags_get(o, mask)   (EWL_OBJECT(o)->flags & mask)
 Retrieves the current setting of the object flags for o.
#define ewl_object_flags_has(o, check_flags, mask)   (!!(EWL_OBJECT(o)->flags & ((check_flags) & mask)))
 Determines if an object has the requested flags set.
#define ewl_object_flags_has_all(o, check_flags, mask)   ((EWL_OBJECT(o)->flags & ((check_flags) & mask)) == ((check_flags) & mask))
 Determines if an object has all of the requested flags set.
#define ewl_object_in_tab_list_get(o)   (ewl_object_flags_get(o, EWL_FLAG_PROPERTY_IN_TAB_LIST))
 Retrieves the current setting of the in tab list flag for o.
#define ewl_object_in_tab_list_set(o, val)
 Changes the tab list flag value to match val.
#define EWL_OBJECT_MAX_SIZE   (INT_MAX)
#define EWL_OBJECT_MIN_SIZE   (1)
#define ewl_object_queued_add(o, queued)   ewl_object_flags_add(o, queued, EWL_FLAGS_QUEUED_MASK)
#define ewl_object_queued_get(o, queued)   ewl_object_flags_get(o, queued, EWL_FLAGS_QUEUED_MASK)
#define ewl_object_queued_has(o, queued)   ewl_object_flags_has(o, queued, EWL_FLAGS_QUEUED_MASK)
#define ewl_object_queued_remove(o, queued)   ewl_object_flags_remove(o, queued, EWL_FLAGS_QUEUED_MASK)
#define ewl_object_recursive_get(o)   (ewl_object_flags_get(o, EWL_FLAG_PROPERTY_RECURSIVE))
 Retrieves the current setting of the recursive flag for o.
#define ewl_object_recursive_set(o, val)
 Changes the recursive flag value to match val.
#define ewl_object_state_add(o, state)   ewl_object_flags_add(o, state, EWL_FLAGS_STATE_MASK)
#define ewl_object_state_get(o, state)   ewl_object_flags_get(o, state, EWL_FLAGS_STATE_MASK)
#define ewl_object_state_has(o, state)   ewl_object_flags_has(o, state, EWL_FLAGS_STATE_MASK)
#define ewl_object_state_remove(o, state)   ewl_object_flags_remove(o, state, EWL_FLAGS_STATE_MASK)
#define ewl_object_toplevel_get(o)   (ewl_object_flags_get(o, EWL_FLAG_PROPERTY_TOPLEVEL))
 Retrieves the current setting of the top level flag for o.
#define ewl_object_toplevel_set(o, val)
 Changes the top level flag value to match val.
#define ewl_object_visible_add(o, visible)   ewl_object_flags_add(o, visible, EWL_FLAGS_VISIBLE_MASK)
#define ewl_object_visible_get(o, visible)   ewl_object_flags_get(o, visible, EWL_FLAGS_VISIBLE_MASK)
#define ewl_object_visible_has(o, visible)   ewl_object_flags_has(o, visible, EWL_FLAGS_VISIBLE_MASK)
#define ewl_object_visible_remove(o, visible)   ewl_object_flags_remove(o, visible, EWL_FLAGS_VISIBLE_MASK)
#define HIDDEN(o)   (!(EWL_OBJECT(o)->flags & EWL_FLAG_VISIBLE_SHOWN))
#define INSET_BOTTOM(o)   ((const Ewl_Object *)(o))->insets.b
#define INSET_HORIZONTAL(o)   (EWL_OBJECT(o)->insets.l + EWL_OBJECT(o)->insets.r)
#define INSET_LEFT(o)   ((const Ewl_Object *)(o))->insets.l
#define INSET_RIGHT(o)   ((const Ewl_Object *)(o))->insets.r
#define INSET_TOP(o)   ((const Ewl_Object *)(o))->insets.t
#define INSET_VERTICAL(o)   (EWL_OBJECT(o)->insets.t + EWL_OBJECT(o)->insets.b)
#define MAXIMUM_H(o)   ((const Ewl_Object *)(o))->maximum.h
#define MAXIMUM_W(o)   ((const Ewl_Object *)(o))->maximum.w
#define MINIMUM_H(o)   ((const Ewl_Object *)(o))->minimum.h
#define MINIMUM_W(o)   ((const Ewl_Object *)(o))->minimum.w
#define PADDING_BOTTOM(o)   ((const Ewl_Object *)(o))->pad.b
#define PADDING_HORIZONTAL(o)   (EWL_OBJECT(o)->pad.l + EWL_OBJECT(o)->pad.r)
#define PADDING_LEFT(o)   ((const Ewl_Object *)(o))->pad.l
#define PADDING_RIGHT(o)   ((const Ewl_Object *)(o))->pad.r
#define PADDING_TOP(o)   ((const Ewl_Object *)(o))->pad.t
#define PADDING_VERTICAL(o)   (EWL_OBJECT(o)->pad.t + EWL_OBJECT(o)->pad.b)
#define PREFERRED_H(o)   ((const Ewl_Object *)(o))->preferred.h
#define PREFERRED_W(o)   ((const Ewl_Object *)(o))->preferred.w
#define REALIZED(o)   (EWL_OBJECT(o)->flags & EWL_FLAG_VISIBLE_REALIZED)
#define RECURSIVE(o)   (EWL_OBJECT(o)->flags & EWL_FLAG_PROPERTY_RECURSIVE)
#define REVEALED(o)   (EWL_OBJECT(o)->flags & EWL_FLAG_VISIBLE_REVEALED)
#define VISIBLE(o)   (EWL_OBJECT(o)->flags & EWL_FLAG_VISIBLE_SHOWN)

Typedefs

typedef struct Ewl_Object Ewl_Object

Functions

unsigned int ewl_object_alignment_get (Ewl_Object *o)
 Retrieves the current setting of the object alignment for o.
void ewl_object_alignment_set (Ewl_Object *o, unsigned int align)
 Change the alignment of the specified object.
void ewl_object_current_geometry_get (Ewl_Object *o, int *x, int *y, int *w, int *h)
 Retrieve the size and position of object.
int ewl_object_current_h_get (Ewl_Object *o)
 Get the current height of the object.
void ewl_object_current_size_get (Ewl_Object *o, int *w, int *h)
 Retrieve the current size of an object.
int ewl_object_current_w_get (Ewl_Object *o)
 Get the current width of the object.
int ewl_object_current_x_get (Ewl_Object *o)
 get the current x position of the object
int ewl_object_current_y_get (Ewl_Object *o)
 Get the current y position of the object.
unsigned int ewl_object_fill_policy_get (Ewl_Object *o)
 Retrieves the current setting of the object fill policy for o.
void ewl_object_fill_policy_set (Ewl_Object *o, unsigned int fill)
 Change the fill policy of the specified object.
void ewl_object_flags_add (Ewl_Object *o, unsigned int flags, unsigned int mask)
 Add the set of flags specified in flags to o.
void ewl_object_flags_remove (Ewl_Object *o, unsigned int flags, unsigned int mask)
 Removes the set of state flags specified in flags from o.
void ewl_object_geometry_request (Ewl_Object *o, int x, int y, int w, int h)
 Request a new geometry be applied to an object.
void ewl_object_h_request (Ewl_Object *o, int h)
 Request a new width for an object.
int ewl_object_init (Ewl_Object *o)
int ewl_object_insets_bottom_get (Ewl_Object *o)
 Get the bottom insets for the object.
void ewl_object_insets_get (Ewl_Object *o, int *l, int *r, int *t, int *b)
 Retrieve the edge insets of an object.
int ewl_object_insets_left_get (Ewl_Object *o)
 Get the left insets for the object.
int ewl_object_insets_right_get (Ewl_Object *o)
 Get the right insets for the object.
void ewl_object_insets_set (Ewl_Object *o, int l, int r, int t, int b)
 Set the insets around an objects edges.
int ewl_object_insets_top_get (Ewl_Object *o)
 Get the top insets for the object.
int ewl_object_maximum_h_get (Ewl_Object *o)
 Get the maximum height of an object.
void ewl_object_maximum_h_set (Ewl_Object *o, int h)
 Set the minimum height of an object.
void ewl_object_maximum_size_get (Ewl_Object *o, int *w, int *h)
 Retrieve the minimum dimensions of an object.
void ewl_object_maximum_size_set (Ewl_Object *o, int w, int h)
 Set the maximum size of an object.
int ewl_object_maximum_w_get (Ewl_Object *o)
 Get the maximum width of an object.
void ewl_object_maximum_w_set (Ewl_Object *o, int w)
 Set the minimum width of an object.
int ewl_object_minimum_h_get (Ewl_Object *o)
 Get the minimum height of an object.
void ewl_object_minimum_h_set (Ewl_Object *o, int h)
 Set the minimum height of an object.
void ewl_object_minimum_size_get (Ewl_Object *o, int *w, int *h)
 Retrieve the minimum dimensions of an object.
void ewl_object_minimum_size_set (Ewl_Object *o, int w, int h)
 Set the minimum size of an object.
int ewl_object_minimum_w_get (Ewl_Object *o)
 Get the minimum width of an object.
void ewl_object_minimum_w_set (Ewl_Object *o, int w)
 Set the minimum width of an object.
int ewl_object_padding_bottom_get (Ewl_Object *o)
 Get the bottom padding for the object.
void ewl_object_padding_get (Ewl_Object *o, int *l, int *r, int *t, int *b)
 Retrieve the edge padding of an object.
int ewl_object_padding_left_get (Ewl_Object *o)
 Get the left padding for the object.
int ewl_object_padding_right_get (Ewl_Object *o)
 Get the right padding for the object.
void ewl_object_padding_set (Ewl_Object *o, int l, int r, int t, int b)
 Set the padding around an objects edges.
int ewl_object_padding_top_get (Ewl_Object *o)
 Get the top padding for the object.
void ewl_object_place (Ewl_Object *o, int x, int y, int w, int h)
 Assign a specific area to an object.
void ewl_object_position_request (Ewl_Object *o, int x, int y)
 Request a new position be applied to an object.
int ewl_object_preferred_h_get (Ewl_Object *o)
 Get the preferred height of the object.
int ewl_object_preferred_inner_h_get (Ewl_Object *o)
 Get the preferred height of the object.
void ewl_object_preferred_inner_h_set (Ewl_Object *o, int h)
 Set the preferred height of the object.
void ewl_object_preferred_inner_size_get (Ewl_Object *o, int *w, int *h)
 Retrieve the preferred size of an object.
void ewl_object_preferred_inner_size_set (Ewl_Object *o, int w, int h)
 Set the preferred size of the object.
int ewl_object_preferred_inner_w_get (Ewl_Object *o)
 Get the preferred width of the object, ignoring padding and insets.
void ewl_object_preferred_inner_w_set (Ewl_Object *o, int w)
 Set the preferred width of the object.
void ewl_object_preferred_size_get (Ewl_Object *o, int *w, int *h)
 Retrieve the preferred size of an object.
int ewl_object_preferred_w_get (Ewl_Object *o)
 Get the preferred width of the object.
void ewl_object_size_request (Ewl_Object *o, int w, int h)
 Request a new size be applied to an object.
void ewl_object_w_request (Ewl_Object *o, int w)
 Request a new width for an object.
void ewl_object_x_request (Ewl_Object *o, int x)
 Request a new x position for an object.
void ewl_object_y_request (Ewl_Object *o, int y)
 Request a new y position for an object.

Define Documentation

#define CONFIGURED (  ) 

Value:

Used to determine if a widget is scheduled for configure

Referenced by ewl_destroy_request().

#define EWL_OBJECT ( object   )     ((Ewl_Object *) object)

A typecast for accessing the inherited object fields.

Referenced by ewl_border_init(), ewl_border_label_alignment_get(), ewl_border_label_alignment_set(), ewl_box_cb_child_hide(), ewl_box_cb_child_homogeneous_show(), ewl_box_cb_child_resize(), ewl_box_cb_child_show(), ewl_box_homogeneous_set(), ewl_box_orientation_set(), ewl_box_spacing_set(), ewl_button_alignment_get(), ewl_button_alignment_set(), ewl_button_fill_policy_get(), ewl_button_fill_policy_set(), ewl_button_image_set(), ewl_button_init(), ewl_button_label_set(), ewl_calendar_init(), ewl_cell_cb_child_resize(), ewl_cell_cb_child_show(), ewl_cell_init(), ewl_check_init(), ewl_checkbutton_init(), ewl_colordialog_init(), ewl_colorpicker_init(), ewl_combo_cell_init(), ewl_combo_init(), ewl_combo_scrollable_set(), ewl_combo_submenu_new(), ewl_configure_request(), ewl_container_child_resize(), ewl_container_init(), ewl_container_largest_prefer(), ewl_container_reset(), ewl_container_sum_prefer(), ewl_context_menu_cb_mouse_move(), ewl_context_menu_container_set(), ewl_context_menu_init(), ewl_cursor_init(), ewl_datepicker_init(), ewl_destroy_request(), ewl_dialog_action_alignment_get(), ewl_dialog_action_alignment_set(), ewl_dialog_action_fill_policy_get(), ewl_dialog_action_fill_policy_set(), ewl_dialog_action_position_set(), ewl_dialog_has_separator_set(), ewl_dialog_init(), ewl_dnd_accepted_types_set(), ewl_dnd_provided_types_set(), ewl_embed_active_set(), ewl_embed_cb_focus_out(), ewl_embed_dnd_drop_feed(), ewl_embed_dnd_position_feed(), ewl_embed_info_widgets_cleanup(), ewl_embed_init(), ewl_embed_mouse_down_feed(), ewl_embed_mouse_move_feed(), ewl_embed_mouse_out_feed(), ewl_embed_mouse_up_feed(), ewl_embed_tab_order_insert(), ewl_embed_tab_order_remove(), ewl_embed_widget_find(), ewl_entry_cb_configure(), ewl_entry_editable_set(), ewl_entry_init(), ewl_expansion_init(), ewl_filelist_init(), ewl_filelist_selected_file_preview_get(), ewl_filelist_view_widget_fetch(), ewl_filepicker_init(), ewl_floater_cb_follow_configure(), ewl_floater_init(), ewl_floater_position_set(), ewl_grid_cb_configure(), ewl_histogram_init(), ewl_icon_alt_text_set(), ewl_icon_image_set(), ewl_icon_init(), ewl_image_cb_reveal(), ewl_image_constrain_set(), ewl_image_init(), ewl_image_scale_set(), ewl_image_size_set(), ewl_label_init(), ewl_menu_item_init(), ewl_menu_mouse_feed(), ewl_menubar_from_info(), ewl_menubar_orientation_set(), ewl_notebook_cb_child_show(), ewl_notebook_init(), ewl_notebook_tabbar_alignment_get(), ewl_notebook_tabbar_alignment_set(), ewl_notebook_tabbar_position_set(), ewl_object_preferred_inner_h_set(), ewl_object_preferred_inner_w_set(), ewl_overlay_cb_child_resize(), ewl_overlay_cb_child_show(), ewl_overlay_cb_configure(), ewl_overlay_init(), ewl_paned_cb_child_hide(), ewl_paned_cb_child_resize(), ewl_paned_cb_child_show(), ewl_paned_init(), ewl_popup_init(), ewl_progressbar_cb_configure(), ewl_progressbar_init(), ewl_realize_cancel_request(), ewl_realize_request(), ewl_row_cb_child_hide(), ewl_row_cb_child_resize(), ewl_row_cb_child_show(), ewl_row_cb_configure(), ewl_row_header_set(), ewl_row_init(), ewl_scrollbar_init(), ewl_scrollbar_orientation_set(), ewl_scrollpane_cb_configure(), ewl_scrollpane_cb_focus_jump(), ewl_scrollpane_hscrollbar_flag_set(), ewl_scrollpane_init(), ewl_scrollpane_vscrollbar_flag_set(), ewl_seeker_cb_button_mouse_down(), ewl_seeker_cb_child_show(), ewl_seeker_cb_configure(), ewl_seeker_cb_mouse_down(), ewl_seeker_cb_mouse_move(), ewl_seeker_init(), ewl_seeker_orientation_set(), ewl_separator_init(), ewl_separator_orientation_set(), ewl_shadow_init(), ewl_spectrum_cb_configure(), ewl_spectrum_init(), ewl_spinner_cb_configure(), ewl_spinner_init(), ewl_statusbar_init(), ewl_table_cb_child_show(), ewl_table_cb_configure(), ewl_table_init(), ewl_text_init(), ewl_text_trigger_area_add(), ewl_text_wrap_set(), ewl_toolbar_init(), ewl_tree_cb_configure(), ewl_tree_cb_node_child_hide(), ewl_tree_cb_node_child_show(), ewl_tree_cb_node_configure(), ewl_tree_init(), ewl_tree_node_init(), ewl_widget_cb_mouse_move(), ewl_widget_cb_mouse_up(), ewl_widget_cb_obscure(), ewl_widget_cb_realize(), ewl_widget_cb_reveal(), ewl_widget_cb_unrealize(), ewl_widget_clipped_is(), ewl_widget_clipped_set(), ewl_widget_disable(), ewl_widget_enable(), ewl_widget_focusable_get(), ewl_widget_focusable_set(), ewl_widget_hide(), ewl_widget_ignore_focus_change_get(), ewl_widget_ignore_focus_change_set(), ewl_widget_init(), ewl_widget_internal_is(), ewl_widget_internal_set(), ewl_widget_obscure(), ewl_widget_onscreen_is(), ewl_widget_print(), ewl_widget_print_verbose(), ewl_widget_realize(), ewl_widget_reveal(), ewl_widget_show(), ewl_widget_unrealize(), ewl_window_cb_configure(), ewl_window_cb_realize(), and ewl_window_init().

#define ewl_object_custom_h_set ( o,
 ) 

Value:

Parameters:
o,: The object to work with
h,: The height to set A convenience method to set a custom height onto a widget

#define ewl_object_custom_size_set ( o,
w,
 ) 

Value:

Parameters:
o,: The object to work with
w,: The width to set
h,: The height to set A convenience method to set a custom size onto a widget

#define ewl_object_custom_w_set ( o,
 ) 

Value:

Parameters:
o,: The object to work with
w,: The width to set A convenience method to set a custom width onto a widget

#define ewl_object_flags_get ( o,
mask   )     (EWL_OBJECT(o)->flags & mask)

Retrieves the current setting of the object flags for o.

Parameters:
o,: the parameter to retrieve the current value of object flags
mask,: get only the flags specified in mask
Returns:
Returns the current setting of the object flags for o.

Referenced by ewl_object_alignment_get(), ewl_object_fill_policy_get(), ewl_realize_request(), and ewl_widget_cb_reveal().

#define ewl_object_flags_has ( o,
check_flags,
mask   )     (!!(EWL_OBJECT(o)->flags & ((check_flags) & mask)))

Determines if an object has the requested flags set.

Parameters:
o,: the object to check for a specified flags
check_flags,: the bitmask of flags to check on the object
mask,: get only the flags specified in mask
Returns:
Returns TRUE if any of the specified flags are set, FALSE otherwise.

Referenced by ewl_container_reset(), ewl_embed_dnd_drop_feed(), ewl_embed_dnd_position_feed(), ewl_widget_cb_mouse_move(), ewl_widget_cb_obscure(), ewl_widget_cb_reveal(), ewl_widget_clipped_is(), ewl_widget_focusable_get(), ewl_widget_ignore_focus_change_get(), and ewl_widget_internal_is().

#define ewl_object_flags_has_all ( o,
check_flags,
mask   )     ((EWL_OBJECT(o)->flags & ((check_flags) & mask)) == ((check_flags) & mask))

Determines if an object has all of the requested flags set.

Parameters:
o,: the object to check for a specified flags
check_flags,: the bitmask of flags to check on the object
mask,: get only the flags specified in mask
Returns:
Returns TRUE if the specified flags are set, FALSE otherwise.

#define ewl_object_in_tab_list_get (  )     (ewl_object_flags_get(o, EWL_FLAG_PROPERTY_IN_TAB_LIST))

Retrieves the current setting of the in tab list flag for o.

Parameters:
o,: the parameter to retrieve the current value of the in tab list flag
Returns:
Returns the current setting of the in tab list flag for o.

Referenced by ewl_embed_tab_order_insert().

#define ewl_object_in_tab_list_set ( o,
val   ) 

Value:

Changes the tab list flag value to match val.

Parameters:
o,: the object to change the in tab list
val,: a boolean indicating the value of the tab list flag
Returns:
Returns no value.

Referenced by ewl_embed_tab_order_insert(), and ewl_embed_tab_order_remove().

#define EWL_OBJECT_MAX_SIZE   (INT_MAX)

#define EWL_OBJECT_MIN_SIZE   (1)

#define ewl_object_queued_add ( o,
queued   )     ewl_object_flags_add(o, queued, EWL_FLAGS_QUEUED_MASK)

Parameters:
o,: The object to work with
queued,: Add the given queue flag to the object Adds the given queue flag queued to the object o

Referenced by ewl_configure_request(), ewl_destroy_request(), ewl_realize_request(), and ewl_widget_realize().

#define ewl_object_queued_get ( o,
queued   )     ewl_object_flags_get(o, queued, EWL_FLAGS_QUEUED_MASK)

Retrieve the value for the queued queue flag

#define ewl_object_queued_has ( o,
queued   )     ewl_object_flags_has(o, queued, EWL_FLAGS_QUEUED_MASK)

#define ewl_object_queued_remove ( o,
queued   )     ewl_object_flags_remove(o, queued, EWL_FLAGS_QUEUED_MASK)

Remove the queued flag from the o object

Referenced by ewl_realize_cancel_request(), and ewl_widget_realize().

#define ewl_object_recursive_get (  )     (ewl_object_flags_get(o, EWL_FLAG_PROPERTY_RECURSIVE))

Retrieves the current setting of the recursive flag for o.

Parameters:
o,: the parameter to retrieve the current value of recursive flag
Returns:
Returns the current setting of the recursive flag for o.

Referenced by ewl_destroy_request().

#define ewl_object_recursive_set ( o,
val   ) 

Value:

Changes the recursive flag value to match val.

Parameters:
o,: the object to change the recursive flag
val,: a boolean indicating the value of the recursive flag
Returns:
Returns no value.

Referenced by ewl_container_init().

#define ewl_object_state_add ( o,
state   )     ewl_object_flags_add(o, state, EWL_FLAGS_STATE_MASK)

Parameters:
o,: The object to work with
state,: The state to set into the object Adds the given state state to the object o

Referenced by ewl_embed_mouse_down_feed(), ewl_embed_mouse_move_feed(), ewl_widget_cb_mouse_move(), ewl_widget_disable(), and ewl_widget_enable().

#define ewl_object_state_get ( o,
state   )     ewl_object_flags_get(o, state, EWL_FLAGS_STATE_MASK)

Parameters:
o,: The object to work with
state,: The state to get Retrives the given state state from the object o

#define ewl_object_state_has ( o,
state   )     ewl_object_flags_has(o, state, EWL_FLAGS_STATE_MASK)

Parameters:
o,: The object to check
state,: The state to check Checks if the given state state is set on the given object o

Referenced by ewl_embed_cb_focus_out(), ewl_embed_mouse_move_feed(), ewl_entry_editable_set(), ewl_seeker_cb_mouse_down(), ewl_seeker_cb_mouse_move(), ewl_widget_cb_mouse_move(), and ewl_widget_cb_mouse_up().

#define ewl_object_state_remove ( o,
state   )     ewl_object_flags_remove(o, state, EWL_FLAGS_STATE_MASK)

#define ewl_object_toplevel_get (  )     (ewl_object_flags_get(o, EWL_FLAG_PROPERTY_TOPLEVEL))

Retrieves the current setting of the top level flag for o.

Parameters:
o,: the parameter to retrieve the current value of top level flag
Returns:
Returns the current setting of the top level flag for o.

Referenced by ewl_configure_request(), ewl_embed_widget_find(), and ewl_widget_realize().

#define ewl_object_toplevel_set ( o,
val   ) 

Value:

Changes the top level flag value to match val.

Parameters:
o,: the object to change the top level flag
val,: a boolean indicating the value of the top level flag
Returns:
Returns no value.

Referenced by ewl_embed_init().

#define ewl_object_visible_add ( o,
visible   )     ewl_object_flags_add(o, visible, EWL_FLAGS_VISIBLE_MASK)

Add the visible flag to the object o

Referenced by ewl_widget_realize(), ewl_widget_reveal(), and ewl_widget_show().

#define ewl_object_visible_get ( o,
visible   )     ewl_object_flags_get(o, visible, EWL_FLAGS_VISIBLE_MASK)

Retrieves the visble flag from the object o

#define ewl_object_visible_has ( o,
visible   )     ewl_object_flags_has(o, visible, EWL_FLAGS_VISIBLE_MASK)

Check if the visible flag is set in the object o

#define ewl_object_visible_remove ( o,
visible   )     ewl_object_flags_remove(o, visible, EWL_FLAGS_VISIBLE_MASK)

Remove the visible flag from the object o

Referenced by ewl_widget_hide(), ewl_widget_obscure(), and ewl_widget_unrealize().

#define HIDDEN (  )     (!(EWL_OBJECT(o)->flags & EWL_FLAG_VISIBLE_SHOWN))

Used to determine if a widget is hidden.

Referenced by ewl_container_child_resize(), ewl_tree_cb_node_child_add(), and ewl_widget_hide().

#define INSET_BOTTOM (  )     ((const Ewl_Object *)(o))->insets.b

#define INSET_HORIZONTAL (  )     (EWL_OBJECT(o)->insets.l + EWL_OBJECT(o)->insets.r)

#define INSET_LEFT (  )     ((const Ewl_Object *)(o))->insets.l

#define INSET_RIGHT (  )     ((const Ewl_Object *)(o))->insets.r

#define INSET_TOP (  )     ((const Ewl_Object *)(o))->insets.t

#define INSET_VERTICAL (  )     (EWL_OBJECT(o)->insets.t + EWL_OBJECT(o)->insets.b)

#define MAXIMUM_H (  )     ((const Ewl_Object *)(o))->maximum.h

#define MAXIMUM_W (  )     ((const Ewl_Object *)(o))->maximum.w

#define MINIMUM_H (  )     ((const Ewl_Object *)(o))->minimum.h

#define MINIMUM_W (  )     ((const Ewl_Object *)(o))->minimum.w

#define PADDING_BOTTOM (  )     ((const Ewl_Object *)(o))->pad.b

Retrieve the size of the bottom pad

Referenced by ewl_object_padding_bottom_get().

#define PADDING_HORIZONTAL (  )     (EWL_OBJECT(o)->pad.l + EWL_OBJECT(o)->pad.r)

#define PADDING_LEFT (  )     ((const Ewl_Object *)(o))->pad.l

Retrieve the size of the left pad

Referenced by ewl_object_current_x_get(), ewl_object_padding_left_get(), and ewl_object_x_request().

#define PADDING_RIGHT (  )     ((const Ewl_Object *)(o))->pad.r

Retrieve the size of the right pad

Referenced by ewl_object_padding_right_get().

#define PADDING_TOP (  )     ((const Ewl_Object *)(o))->pad.t

Retrieve the size of the top pad

Referenced by ewl_object_current_y_get(), ewl_object_padding_top_get(), and ewl_object_y_request().

#define PADDING_VERTICAL (  )     (EWL_OBJECT(o)->pad.t + EWL_OBJECT(o)->pad.b)

#define RECURSIVE (  )     (EWL_OBJECT(o)->flags & EWL_FLAG_PROPERTY_RECURSIVE)

Used to test if a widget is recursive, aka. an Ewl_Container

Referenced by ewl_container_child_at_recursive_get(), and ewl_embed_info_widgets_cleanup().

#define REVEALED (  )     (EWL_OBJECT(o)->flags & EWL_FLAG_VISIBLE_REVEALED)


Typedef Documentation

typedef struct Ewl_Object Ewl_Object

The base class inherited by all widgets. Provides methods for size and position.


Function Documentation

unsigned int ewl_object_alignment_get ( Ewl_Object o  ) 

Retrieves the current setting of the object alignment for o.

Parameters:
o,: the parameter to retrieve the current value of object alignment
Returns:
Returns the current setting of the object alignment for o.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FLAGS_ALIGN_MASK, and ewl_object_flags_get.

Referenced by ewl_border_label_alignment_get(), ewl_button_alignment_get(), ewl_dialog_action_alignment_get(), ewl_floater_cb_follow_configure(), ewl_notebook_tabbar_alignment_get(), and ewl_widget_print_verbose().

void ewl_object_alignment_set ( Ewl_Object o,
unsigned int  align 
)

Change the alignment of the specified object.

Parameters:
o,: the object to change alignment
align,: the new alignment for the object
Returns:
Returns no value. Stores the new alignment value into the object for use when laying out the object. Possible values for the alignment are EWL_FLAG_ALIGN_CENTER, EWL_FLAG_ALIGN_LEFT, EWL_FLAG_ALIGN_RIGHT, EWL_FLAG_ALIGN_TOP and EWL_FLAG_ALIGN_BOTTOM. You can combine those with the bitwise OR, e.g. EWL_FLAG_ALIGN_TOP | EWL_FLAG_ALIGN_LEFT.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_FLAGS_ALIGN_MASK, ewl_object_flags_add(), ewl_object_flags_remove(), EWL_WIDGET, and ewl_widget_configure().

Referenced by ewl_border_label_alignment_set(), ewl_button_alignment_set(), ewl_button_image_set(), ewl_button_init(), ewl_calendar_init(), ewl_checkbutton_init(), ewl_combo_init(), ewl_context_menu_init(), ewl_dialog_action_alignment_set(), ewl_expansion_init(), ewl_filelist_selected_file_preview_get(), ewl_filelist_view_widget_fetch(), ewl_floater_init(), ewl_icon_alt_text_set(), ewl_icon_image_set(), ewl_label_init(), ewl_notebook_init(), ewl_notebook_tabbar_alignment_set(), ewl_paned_init(), ewl_progressbar_init(), ewl_scrollbar_init(), ewl_separator_init(), ewl_spinner_init(), ewl_statusbar_init(), and ewl_toolbar_init().

void ewl_object_current_geometry_get ( Ewl_Object o,
int *  x,
int *  y,
int *  w,
int *  h 
)

Retrieve the size and position of object.

Parameters:
o,: the object to retrieve size and position
x,: a pointer to the integer to store the x coordinate
y,: a pointer to the integer to store the y coordinate
w,: a pointer to the integer to store the width
h,: a pointer to the integer to store the height
Returns:
Returns no value. Examines o and stores it's size and position into the integers pointed to by the parameters x, y, w, and h.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_current_h_get(), ewl_object_current_w_get(), ewl_object_current_x_get(), and ewl_object_current_y_get().

Referenced by ewl_scrollpane_cb_focus_jump(), ewl_seeker_cb_button_mouse_down(), and ewl_seeker_cb_mouse_down().

void ewl_object_current_size_get ( Ewl_Object o,
int *  w,
int *  h 
)

Retrieve the current size of an object.

Parameters:
o,: the object to retrieve size information
w,: a pointer to the integer to store the width of the object
h,: a pointer to the integer to store the height of the object
Returns:
Returns no value. Stores the width and height of the object into w and h respectively.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_current_h_get(), and ewl_object_current_w_get().

Referenced by ewl_context_menu_cb_mouse_move(), and ewl_menu_mouse_feed().

int ewl_object_current_x_get ( Ewl_Object o  ) 

int ewl_object_current_y_get ( Ewl_Object o  ) 

Get the current y position of the object.

Parameters:
o,: the object to retrieve the current y position
Returns:
Returns the current y position of the object.

References CURRENT_Y, DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, INSET_TOP, and PADDING_TOP.

Referenced by ewl_floater_cb_follow_configure(), ewl_object_current_geometry_get(), ewl_overlay_cb_child_resize(), ewl_overlay_cb_child_show(), ewl_overlay_cb_configure(), ewl_scrollpane_cb_focus_jump(), ewl_widget_onscreen_is(), ewl_widget_print(), and ewl_window_cb_configure().

unsigned int ewl_object_fill_policy_get ( Ewl_Object o  ) 

Retrieves the current setting of the object fill policy for o.

Parameters:
o,: the parameter to retrieve the current value of object fill policy
Returns:
Returns the current setting of the object fill policy for o.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FLAGS_FILL_MASK, and ewl_object_flags_get.

Referenced by ewl_button_fill_policy_get(), ewl_dialog_action_fill_policy_get(), ewl_object_current_h_get(), ewl_object_current_w_get(), ewl_object_preferred_inner_h_set(), ewl_object_preferred_inner_w_set(), ewl_scrollpane_cb_configure(), ewl_scrollpane_hscrollbar_flag_set(), ewl_scrollpane_vscrollbar_flag_set(), and ewl_widget_print_verbose().

void ewl_object_fill_policy_set ( Ewl_Object o,
unsigned int  fill 
)

Change the fill policy of the specified object.

Parameters:
o,: the object to change fill policy
fill,: the new fill policy for the object
Returns:
Returns no value.
See also:
Enums
Stores the new fill policy value into the object for use when laying out the object. Possible values for the fill policy are EWL_FLAG_FILL_NONE, EWL_FLAG_FILL_HSHRINK, EWL_FLAG_FILL_VSHRINK, EWL_FLAG_FILL_SHRINK, EWL_FLAG_FILL_HFILL, EWL_FLAG_FILL_VFILL and EWL_FLAG_FILL_FILL. You can combine those with a bitwise OR, e.g. EWL_FLAG_FILL_VFILL | EWL_FLAG_FILL_HSHRINK.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, EWL_FLAGS_FILL_MASK, ewl_object_flags_add(), ewl_object_flags_remove(), EWL_WIDGET, ewl_widget_configure(), and flags.

Referenced by ewl_border_init(), ewl_button_fill_policy_set(), ewl_button_image_set(), ewl_button_init(), ewl_button_label_set(), ewl_calendar_init(), ewl_cell_init(), ewl_check_init(), ewl_checkbutton_init(), ewl_colordialog_init(), ewl_colorpicker_init(), ewl_combo_cell_init(), ewl_combo_init(), ewl_combo_scrollable_set(), ewl_combo_submenu_new(), ewl_context_menu_container_set(), ewl_cursor_init(), ewl_datepicker_init(), ewl_dialog_action_fill_policy_set(), ewl_dialog_action_position_set(), ewl_dialog_has_separator_set(), ewl_dialog_init(), ewl_embed_init(), ewl_entry_init(), ewl_expansion_init(), ewl_filelist_init(), ewl_filepicker_init(), ewl_floater_init(), ewl_icon_alt_text_set(), ewl_icon_init(), ewl_image_init(), ewl_label_init(), ewl_menu_item_init(), ewl_menubar_from_info(), ewl_menubar_orientation_set(), ewl_notebook_init(), ewl_overlay_init(), ewl_paned_init(), ewl_popup_init(), ewl_progressbar_init(), ewl_row_header_set(), ewl_row_init(), ewl_scrollbar_init(), ewl_scrollbar_orientation_set(), ewl_scrollpane_cb_configure(), ewl_scrollpane_hscrollbar_flag_set(), ewl_scrollpane_init(), ewl_scrollpane_vscrollbar_flag_set(), ewl_seeker_init(), ewl_seeker_orientation_set(), ewl_separator_init(), ewl_separator_orientation_set(), ewl_shadow_init(), ewl_spectrum_init(), ewl_spinner_init(), ewl_statusbar_init(), ewl_table_init(), ewl_text_init(), ewl_text_wrap_set(), ewl_toolbar_init(), ewl_tree_init(), ewl_tree_node_init(), and ewl_window_init().

void ewl_object_flags_add ( Ewl_Object o,
unsigned int  flags,
unsigned int  mask 
)

Add the set of flags specified in flags to o.

Parameters:
o,: the object to set the specified object flags
flags,: a bitmask of new flags to be set in the object
mask,: a bitmask limiting added flags to a certain set
Returns:
Returns no value.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, and flags.

Referenced by ewl_dnd_accepted_types_set(), ewl_dnd_provided_types_set(), ewl_object_alignment_set(), ewl_object_fill_policy_set(), ewl_widget_clipped_set(), ewl_widget_focusable_set(), ewl_widget_ignore_focus_change_set(), and ewl_widget_internal_set().

void ewl_object_flags_remove ( Ewl_Object o,
unsigned int  flags,
unsigned int  mask 
)

Removes the set of state flags specified in flags from o.

Parameters:
o,: the object to remove specified state flags
flags,: a bitmask of flags to be removed from the object
mask,: a bitmask limiting removed flags to a certain set
Returns:
Returns no value.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, and flags.

Referenced by ewl_dnd_accepted_types_set(), ewl_dnd_provided_types_set(), ewl_object_alignment_set(), ewl_object_fill_policy_set(), ewl_widget_clipped_set(), ewl_widget_focusable_set(), ewl_widget_ignore_focus_change_set(), and ewl_widget_internal_set().

void ewl_object_geometry_request ( Ewl_Object o,
int  x,
int  y,
int  w,
int  h 
)

Request a new geometry be applied to an object.

Parameters:
o,: the object to request a new size
x,: the x coordinate to request be applied to the object
y,: the y coordinate to request be applied to the object
w,: the width to request be applied to the object
h,: the height to request be applied to the object
Returns:
Returns no value. The given geometry is requested to be applied to the object. This is the usual method for requesting a new geometry for an object.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_position_request(), and ewl_object_size_request().

Referenced by ewl_entry_cb_configure(), ewl_progressbar_cb_configure(), ewl_scrollpane_cb_configure(), ewl_table_cb_configure(), ewl_text_trigger_area_add(), and ewl_tree_cb_node_configure().

void ewl_object_h_request ( Ewl_Object o,
int  h 
)

Request a new width for an object.

Parameters:
o,: the object to request a new height
h,: the new height to be applied to the object
Returns:
Returns no value. The given height is stored to be applied to the object o at a later time.

References current, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_FLAG_FILL_VFILL, EWL_FLAG_FILL_VSHRINK, EWL_WIDGET, ewl_widget_configure(), flags, h, INSET_VERTICAL, MAXIMUM_H, MINIMUM_H, PADDING_VERTICAL, and preferred.

Referenced by ewl_object_maximum_h_set(), ewl_object_maximum_w_set(), ewl_object_minimum_h_set(), ewl_object_size_request(), and ewl_row_cb_configure().

int ewl_object_insets_bottom_get ( Ewl_Object o  ) 

Get the bottom insets for the object.

Parameters:
o,: the ewl object to retrieve the bottom insets
Returns:
Returns the bottom insets for the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, and INSET_BOTTOM.

Referenced by ewl_widget_print_verbose().

void ewl_object_insets_get ( Ewl_Object o,
int *  l,
int *  r,
int *  t,
int *  b 
)

Retrieve the edge insets of an object.

Parameters:
o,: the object to retrieve insets
l,: a pointer to an integer that receives the insets of the left side
r,: a pointer to an integer that receives the insets of the right side
t,: a pointer to an integer that receives the insets of the top side
b,: a pointer to an integer that receives the insets of the bottom side
Returns:
Returns no value. Stores the edge insets of the object o into the integer pointer parameters passed in.

References b, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, insets, l, r, and t.

Referenced by ewl_widget_cb_realize(), and ewl_widget_cb_unrealize().

int ewl_object_insets_left_get ( Ewl_Object o  ) 

Get the left insets for the object.

Parameters:
o,: the ewl object to retrieve the left insets
Returns:
Returns the left insets for the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, and INSET_LEFT.

Referenced by ewl_widget_print_verbose().

int ewl_object_insets_right_get ( Ewl_Object o  ) 

Get the right insets for the object.

Parameters:
o,: the ewl object to retrieve the right insets
Returns:
Returns the right insets for the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, and INSET_RIGHT.

Referenced by ewl_widget_print_verbose().

void ewl_object_insets_set ( Ewl_Object o,
int  l,
int  r,
int  t,
int  b 
)

Set the insets around an objects edges.

Parameters:
o,: the object to change the insets
l,: the new insets along the left side of the object
r,: the new insets along the right side of the object
t,: the new insets along the top side of the object
b,: the new insets along the bottom side of the object
Returns:
Returns no value. Stores the values of l, r, t and b into the object to be used for distancing it's edges from other widgets when laying out.

References b, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_container_child_resize(), EWL_ORIENTATION_HORIZONTAL, EWL_ORIENTATION_VERTICAL, EWL_WIDGET, insets, l, r, and t.

Referenced by ewl_widget_cb_realize(), and ewl_widget_cb_unrealize().

int ewl_object_insets_top_get ( Ewl_Object o  ) 

Get the top insets for the object.

Parameters:
o,: the ewl object to retrieve the top insets
Returns:
Returns the top insets for the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, and INSET_TOP.

Referenced by ewl_widget_print_verbose().

int ewl_object_maximum_h_get ( Ewl_Object o  ) 

Get the maximum height of an object.

Parameters:
o,: the object to get the maximum height
Returns:
Returns the maximum height of the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FLAG_FILL_VFILL, flags, INSET_VERTICAL, MAXIMUM_H, PADDING_VERTICAL, and PREFERRED_H.

Referenced by ewl_object_maximum_size_get(), ewl_widget_print_verbose(), and ewl_window_cb_realize().

void ewl_object_maximum_h_set ( Ewl_Object o,
int  h 
)

Set the minimum height of an object.

Parameters:
o,: the object to change the maximum height
h,: the new maximum height
Returns:
Returns no value. Sets the maximum height of the object o to h. If the current height or minimum width are less than the new maximum, they are set to the new maximum height.

References CURRENT_H, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_h_request(), EWL_OBJECT_MAX_SIZE, EWL_OBJECT_MIN_SIZE, ewl_object_preferred_inner_h_set(), h, maximum, MAXIMUM_H, minimum, MINIMUM_H, and PREFERRED_H.

Referenced by ewl_combo_scrollable_set(), ewl_object_maximum_size_set(), and ewl_widget_cb_realize().

void ewl_object_maximum_size_get ( Ewl_Object o,
int *  w,
int *  h 
)

Retrieve the minimum dimensions of an object.

Parameters:
o,: the object to retrieve the maximum dimensions
w,: a pointer to an integer to store the maximum width
h,: a pointer to an integer to store the maximum height
Returns:
Returns no value. Stores the maximum height and width of the object into the integers pointed to by w and h respectively.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_maximum_h_get(), and ewl_object_maximum_w_get().

void ewl_object_maximum_size_set ( Ewl_Object o,
int  w,
int  h 
)

Set the maximum size of an object.

Parameters:
o,: the object to change the maximum size
w,: the new maximum width
h,: the new maximum height
Returns:
Returns no value. Sets the maximum size of the object o to w x h. If the current size or minimum size are less than the new maximum, they are set to the new maximum size.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_maximum_h_set(), and ewl_object_maximum_w_set().

Referenced by ewl_colorpicker_init(), ewl_object_init(), and ewl_window_cb_realize().

int ewl_object_maximum_w_get ( Ewl_Object o  ) 

Get the maximum width of an object.

Parameters:
o,: the object to get the maximum width
Returns:
Returns the maximum width of the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FLAG_FILL_HFILL, flags, INSET_HORIZONTAL, MAXIMUM_W, PADDING_HORIZONTAL, and PREFERRED_W.

Referenced by ewl_object_maximum_size_get(), ewl_widget_print_verbose(), and ewl_window_cb_realize().

void ewl_object_maximum_w_set ( Ewl_Object o,
int  w 
)

Set the minimum width of an object.

Parameters:
o,: the object to change the maximum width
w,: the new maximum width
Returns:
Returns no value. Sets the maximum width of the object o to w. If the current width or minimum width are less than the new maximum, they are set to the new maximum width.

References CURRENT_W, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_h_request(), EWL_OBJECT_MAX_SIZE, EWL_OBJECT_MIN_SIZE, ewl_object_preferred_inner_w_set(), maximum, MAXIMUM_W, MINIMUM_W, PREFERRED_W, and w.

Referenced by ewl_object_maximum_size_set(), and ewl_widget_cb_realize().

int ewl_object_minimum_h_get ( Ewl_Object o  ) 

Get the minimum height of an object.

Parameters:
o,: the object to get the minimum height
Returns:
Returns the minimum height of the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FLAG_FILL_VSHRINK, flags, INSET_VERTICAL, MINIMUM_H, PADDING_VERTICAL, and PREFERRED_H.

Referenced by ewl_object_minimum_size_get(), and ewl_widget_print_verbose().

void ewl_object_minimum_h_set ( Ewl_Object o,
int  h 
)

Set the minimum height of an object.

Parameters:
o,: the object to change the minimum height
h,: the new minimum height
Returns:
Returns no value. Sets the minimum height of the object o to h. If the current height or maximum height are less than the new minimum, they are set to the new minimum height.

References CURRENT_H, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_container_child_resize(), ewl_object_h_request(), EWL_OBJECT_MAX_SIZE, EWL_OBJECT_MIN_SIZE, EWL_ORIENTATION_VERTICAL, EWL_WIDGET, h, MAXIMUM_H, minimum, MINIMUM_H, and PREFERRED_H.

Referenced by ewl_colorpicker_init(), ewl_object_minimum_size_set(), and ewl_widget_cb_realize().

void ewl_object_minimum_size_get ( Ewl_Object o,
int *  w,
int *  h 
)

Retrieve the minimum dimensions of an object.

Parameters:
o,: the object to retrieve the minimum dimensions
w,: a pointer to an integer to store the minimum width
h,: a pointer to an integer to store the minimum height
Returns:
Returns no value. Stores the minimum height and width of object o into the integers pointed to by w and h respectively.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_minimum_h_get(), and ewl_object_minimum_w_get().

void ewl_object_minimum_size_set ( Ewl_Object o,
int  w,
int  h 
)

Set the minimum size of an object.

Parameters:
o,: the object to change the minimum size
w,: the new minimum width
h,: the new minimum height
Returns:
Returns no value. Sets the minimum size of the object o to w x h. If the current size or maximum size are less than the new minimum, they are set to the new minimum size.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_minimum_h_set(), and ewl_object_minimum_w_set().

Referenced by ewl_colorpicker_init(), and ewl_object_init().

int ewl_object_minimum_w_get ( Ewl_Object o  ) 

Get the minimum width of an object.

Parameters:
o,: the object to get the minimum width
Returns:
Returns the minimum width of the object o.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FLAG_FILL_HSHRINK, flags, INSET_HORIZONTAL, MINIMUM_W, PADDING_HORIZONTAL, and PREFERRED_W.

Referenced by ewl_object_minimum_size_get(), and ewl_widget_print_verbose().

void ewl_object_minimum_w_set ( Ewl_Object o,
int  w 
)

Set the minimum width of an object.

Parameters:
o,: the object to change the minimum width
w,: the new minimum width
Returns:
Returns no value. Sets the minimum width of the object o to w. If the current width or maximum width are less than the new minimum, they are set to the new minimum width.

References CURRENT_W, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_container_child_resize(), EWL_OBJECT_MAX_SIZE, EWL_OBJECT_MIN_SIZE, ewl_object_w_request(), EWL_ORIENTATION_HORIZONTAL, EWL_WIDGET, MAXIMUM_W, minimum, MINIMUM_W, PREFERRED_W, and w.

Referenced by ewl_object_minimum_size_set(), and ewl_widget_cb_realize().

int ewl_object_padding_bottom_get ( Ewl_Object o  ) 

Get the bottom padding for the object.

Parameters:
o,: the ewl object to retrieve the bottom padding
Returns:
Returns the bottom padding for the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, and PADDING_BOTTOM.

Referenced by ewl_widget_print_verbose().

void ewl_object_padding_get ( Ewl_Object o,
int *  l,
int *  r,
int *  t,
int *  b 
)

Retrieve the edge padding of an object.

Parameters:
o,: the object to retrieve padding
l,: a pointer to an integer that receives padding of the left side
r,: a pointer to an integer that receives padding of the right side
t,: a pointer to an integer that receives padding of the top side
b,: a pointer to an integer that receives padding of the bottom side
Returns:
Returns no value. Stores the edge padding of the object o into the integer pointer parameters passed in.

References b, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, l, pad, r, and t.

Referenced by ewl_widget_cb_realize(), and ewl_widget_cb_unrealize().

int ewl_object_padding_left_get ( Ewl_Object o  ) 

Get the left padding for the object.

Parameters:
o,: the ewl object to retrieve the left padding
Returns:
Returns the left padding for the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, and PADDING_LEFT.

Referenced by ewl_widget_print_verbose().

int ewl_object_padding_right_get ( Ewl_Object o  ) 

Get the right padding for the object.

Parameters:
o,: the ewl object to retrieve the right padding
Returns:
Returns the right padding for the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, and PADDING_RIGHT.

Referenced by ewl_widget_print_verbose().

void ewl_object_padding_set ( Ewl_Object o,
int  l,
int  r,
int  t,
int  b 
)

Set the padding around an objects edges.

Parameters:
o,: the object to change the padding
l,: the new padding along the left side of the object
r,: the new padding along the right side of the object
t,: the new padding along the top side of the object
b,: the new padding along the bottom side of the object
Returns:
Returns no value. Stores the values of l, r, t and b into the object to be used for distancing it's edges from other widgets when laying out.

References b, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_container_child_resize(), EWL_ORIENTATION_HORIZONTAL, EWL_ORIENTATION_VERTICAL, EWL_WIDGET, l, pad, r, and t.

Referenced by ewl_colorpicker_init(), ewl_widget_cb_realize(), and ewl_widget_cb_unrealize().

int ewl_object_padding_top_get ( Ewl_Object o  ) 

Get the top padding for the object.

Parameters:
o,: the ewl object to retrieve the top padding
Returns:
Returns the top padding for the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, and PADDING_TOP.

Referenced by ewl_widget_print_verbose().

void ewl_object_place ( Ewl_Object o,
int  x,
int  y,
int  w,
int  h 
)

Assign a specific area to an object.

Parameters:
o,: the object to place
x,: the x coordinate of the available area
y,: the y coordinate of the available area
w,: the width of the available area
h,: the height of the available area
Returns:
Returns no value. Attempts to fill the object to the specified area, aligns the object within that area.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_FLAG_ALIGN_BOTTOM, EWL_FLAG_ALIGN_LEFT, EWL_FLAG_ALIGN_RIGHT, EWL_FLAG_ALIGN_TOP, ewl_object_current_h_get(), ewl_object_current_w_get(), ewl_object_position_request(), ewl_object_size_request(), and flags.

Referenced by ewl_box_cb_configure_homogeneous(), ewl_cell_cb_configure(), ewl_grid_cb_configure(), ewl_progressbar_cb_configure(), ewl_row_cb_configure(), ewl_seeker_cb_configure(), and ewl_spinner_cb_configure().

void ewl_object_position_request ( Ewl_Object o,
int  x,
int  y 
)

Request a new position be applied to an object.

Parameters:
o,: the object to request a new size
x,: the x coordinate to request be applied to the object
y,: the y coordinate to request be applied to the object
Returns:
Returns no value. The given position is requested to be applied to the object o at a later time. This is the usual method for requesting a new position for an object.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_x_request(), and ewl_object_y_request().

Referenced by ewl_floater_cb_follow_configure(), ewl_floater_position_set(), ewl_object_geometry_request(), ewl_object_place(), ewl_row_cb_configure(), and ewl_spectrum_cb_configure().

int ewl_object_preferred_inner_h_get ( Ewl_Object o  ) 

Get the preferred height of the object.

Parameters:
o,: the object to retrieve the preferred height
Returns:
Returns the preferred height of the object.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, and PREFERRED_H.

Referenced by ewl_box_cb_child_hide(), ewl_box_cb_child_show(), ewl_image_constrain_set(), and ewl_object_preferred_inner_size_get().

void ewl_object_preferred_inner_size_get ( Ewl_Object o,
int *  w,
int *  h 
)

Retrieve the preferred size of an object.

Parameters:
o,: the object to retrieve size information
w,: a pointer to the integer to store the width of the object
h,: a pointer to the integer to store the height of the object
Returns:
Returns no value. Stores the width and height of object o into w and h respectively, without the insets and padding added.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_preferred_inner_h_get(), and ewl_object_preferred_inner_w_get().

Referenced by ewl_paned_cb_child_hide(), ewl_paned_cb_child_show(), and ewl_table_cb_child_show().

void ewl_object_preferred_inner_size_set ( Ewl_Object o,
int  w,
int  h 
)

Set the preferred size of the object.

Parameters:
o,: the object to change size
w,: the new width of the object
h,: the new height of the object
Returns:
Returns no value. The dimensions of the object o are set to the values of the parameters w, and h unless these values are greater than the objects maximum value or smaller than the objects minimum value. If they are outside these bounds, the size is not altered.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_preferred_inner_h_set(), and ewl_object_preferred_inner_w_set().

Referenced by ewl_box_orientation_set(), ewl_cell_cb_child_resize(), ewl_cell_cb_child_show(), ewl_check_init(), ewl_filepicker_init(), ewl_histogram_init(), ewl_image_size_set(), ewl_notebook_cb_child_show(), ewl_notebook_tabbar_position_set(), ewl_overlay_cb_child_resize(), ewl_paned_cb_child_hide(), ewl_paned_cb_child_show(), ewl_seeker_cb_child_show(), and ewl_table_cb_child_show().

int ewl_object_preferred_inner_w_get ( Ewl_Object o  ) 

Get the preferred width of the object, ignoring padding and insets.

Parameters:
o,: the object to retrieve the preferred width
Returns:
Returns the preferred width of the object o.

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, and PREFERRED_W.

Referenced by ewl_box_cb_child_hide(), ewl_box_cb_child_show(), ewl_image_constrain_set(), and ewl_object_preferred_inner_size_get().

void ewl_object_preferred_size_get ( Ewl_Object o,
int *  w,
int *  h 
)

Retrieve the preferred size of an object.

Parameters:
o,: the object to retrieve size information
w,: a pointer to the integer to store the width of the object
h,: a pointer to the integer to store the height of the object
Returns:
Returns no value. Stores the width and height of object o into w and h respectively.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_preferred_h_get(), and ewl_object_preferred_w_get().

Referenced by ewl_notebook_cb_child_show(), ewl_notebook_tabbar_position_set(), ewl_paned_cb_child_hide(), and ewl_paned_cb_child_show().

void ewl_object_size_request ( Ewl_Object o,
int  w,
int  h 
)

Request a new size be applied to an object.

Parameters:
o,: the object to request a new size
w,: the width to request be applied to the object
h,: the height to request be applied to the object
Returns:
Returns no value. The given size is requested to be applied to the object o at a later time. This is the usual method for requesting a new size for an object.

References DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_object_h_request(), and ewl_object_w_request().

Referenced by ewl_cursor_init(), ewl_object_geometry_request(), ewl_object_place(), ewl_overlay_cb_child_resize(), ewl_overlay_cb_configure(), ewl_seeker_cb_configure(), and ewl_spectrum_cb_configure().

void ewl_object_w_request ( Ewl_Object o,
int  w 
)

Request a new width for an object.

Parameters:
o,: the object to request a new width
w,: the new width to be applied to the object
Returns:
Returns no value. The given width is stored to be applied to the object o at a later time.

References current, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_FLAG_FILL_HFILL, EWL_FLAG_FILL_HSHRINK, EWL_WIDGET, ewl_widget_configure(), flags, INSET_HORIZONTAL, MAXIMUM_W, MINIMUM_W, PADDING_HORIZONTAL, preferred, and w.

Referenced by ewl_object_minimum_w_set(), ewl_object_size_request(), ewl_row_cb_configure(), and ewl_tree_cb_configure().

void ewl_object_x_request ( Ewl_Object o,
int  x 
)

Request a new x position for an object.

Parameters:
o,: the object to request a new x position
x,: the new x coordinate to be applied to the object
Returns:
Returns no value. The given x coordinate is stored to be applied to the object o at a later time.

References current, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_WIDGET, ewl_widget_configure(), INSET_LEFT, PADDING_LEFT, and x.

Referenced by ewl_object_position_request(), ewl_overlay_cb_child_resize(), ewl_row_cb_configure(), ewl_tree_cb_configure(), and ewl_widget_cb_realize().

void ewl_object_y_request ( Ewl_Object o,
int  y 
)

Request a new y position for an object.

Parameters:
o,: the object to request a new y position
y,: the new y coordinate to be applied to the object
Returns:
Returns no value. The given y coordinate is stored to be applied to the object o at a later time.

References current, DCHECK_PARAM_PTR, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_WIDGET, ewl_widget_configure(), INSET_TOP, PADDING_TOP, and y.

Referenced by ewl_object_position_request(), ewl_overlay_cb_child_resize(), and ewl_widget_cb_realize().


Copyright © Enlightenment.org

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