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	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	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_MAX_SIZE (INT_MAX)
#define	EWL_OBJECT_MIN_SIZE (1)
#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_TYPE_BOTTOM(o) ((const Ewl_Object *)(o))->pad_type_b
#define	PADDING_TYPE_LEFT(o) ((const Ewl_Object *)(o))->pad_type_l
#define	PADDING_TYPE_RIGHT(o) ((const Ewl_Object *)(o))->pad_type_r
#define	PADDING_TYPE_TOP(o) ((const Ewl_Object *)(o))->pad_type_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
Typedefs
typedef 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_padding_type_bottom_set (Ewl_Object *o, Ewl_Padding_Type type)
	Set the padding type for the bottom side.
void	ewl_object_padding_type_left_set (Ewl_Object *o, Ewl_Padding_Type type)
	Set the padding type for the left side.
void	ewl_object_padding_type_right_set (Ewl_Object *o, Ewl_Padding_Type type)
	Set the padding type for the right side.
void	ewl_object_padding_type_set (Ewl_Object *o, Ewl_Padding_Type type)
	Set the padding type for all sides.
void	ewl_object_padding_type_top_set (Ewl_Object *o, Ewl_Padding_Type type)
	Set the padding type for the top side.
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 CURRENT_H ( o ) ((const Ewl_Object *)(o))->current.h

Retrieve the current height of the object without insets or padding

#define CURRENT_W ( o ) ((const Ewl_Object *)(o))->current.w

Retrieve the current width of the object without insets or padding

#define CURRENT_X ( o ) ((const Ewl_Object *)(o))->current.x

Retrieve the current x position of the object

#define CURRENT_Y ( o ) ((const Ewl_Object *)(o))->current.y

Retrieve the current y position of the object

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

A typecast for accessing the inherited object fields.

#define ewl_object_custom_h_set	(	o,
		h		)

Value:

{ \
                ewl_object_maximum_h_set(o, h); \
                ewl_object_minimum_h_set(o, h); \
                ewl_object_fill_policy_set(o, ewl_object_fill_policy_get(o) & \
                                ~(EWL_FLAG_FILL_VFILL | EWL_FLAG_FILL_VSHRINKABLE)); \
        }

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,
		h	)

Value:

{ \
                ewl_object_minimum_size_set(o, w, h); \
                ewl_object_maximum_size_set(o, w, h); \
                 ewl_object_fill_policy_set(o, EWL_FLAG_FILL_NONE); \
        }

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,
		w		)

Value:

{ \
                ewl_object_maximum_w_set(o, w); \
                ewl_object_minimum_w_set(o, w); \
                ewl_object_fill_policy_set(o, ewl_object_fill_policy_get(o) & \
                                ~(EWL_FLAG_FILL_HFILL | EWL_FLAG_FILL_HSHRINKABLE)); \
        }

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_MAX_SIZE (INT_MAX)

The maximum possible size any object can receive.

#define EWL_OBJECT_MIN_SIZE (1)

The minimum possible size any object can receive.

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

Retrieve the size of the bottom inset

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

Retrieve the total size of the horizontal insets for the object

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

Retrieve the size of the left inset

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

Retrieve the size of the right inset

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

Retrieve the size of the top inset

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

Retrieve the total size of the vertical insets for the object

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

Retrieve the maximum height of the object

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

Retrieve the maximum width of the widget

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

Retrieve the minimum height of the object

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

Retrieve the minimum width of the object

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

Retrieve the size of the bottom pad

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

Retrieve the total size of the horizontal padding

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

Retrieve the size of the left pad

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

Retrieve the size of the right pad

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

Retrieve the size of the top pad

#define PADDING_TYPE_BOTTOM ( o ) ((const Ewl_Object *)(o))->pad_type_b

Retrieve the type of the bottom pad

#define PADDING_TYPE_LEFT ( o ) ((const Ewl_Object *)(o))->pad_type_l

Retrieve the type of the left pad

#define PADDING_TYPE_RIGHT ( o ) ((const Ewl_Object *)(o))->pad_type_r

Retrieve the type of the right pad

#define PADDING_TYPE_TOP ( o ) ((const Ewl_Object *)(o))->pad_type_t

Retrieve the type of the top pad

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

Retrieve the total size of the vertical padding

#define PREFERRED_H ( o ) ((const Ewl_Object *)(o))->preferred.h

Retrieve the preferred height of the widget

#define PREFERRED_W ( o ) ((const Ewl_Object *)(o))->preferred.w

Retrieve the preferred width of the widget

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.

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.

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.

int ewl_object_current_h_get ( Ewl_Object * o )

Get the current height of the object.

Parameters:

o,:

the object to retrieve the current height

Returns:: Returns 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.

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.

int ewl_object_current_w_get ( Ewl_Object * o )

Get the current width of the object.

Parameters:

o,:

the object to retrieve the current width

Returns:: Returns the current width of the object.

int ewl_object_current_x_get ( Ewl_Object * o )

get the current x position of the object

Parameters:

o,:

the object to retrieve the current x position

Returns:: Returns the current x position of the 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.

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.

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_HSHRINKABLE, EWL_FLAG_FILL_VSHRINKABLE, EWL_FLAG_FILL_SHRINKABLE, 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_HSHRINKABLE.

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.

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.

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.

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.

int ewl_object_init ( Ewl_Object * o )

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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. This values will be overwritten during realization if the padding type is not set to EWL_PADDING_CUSTOM. It's preferable to use ewl_padding_type_set(), because it will use theme defined values instead of hardcoded.

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.

void ewl_object_padding_type_bottom_set	(	Ewl_Object *	o,
		Ewl_Padding_Type	type
	)

Set the padding type for the bottom side.

Parameters:

	o,:	the object to change the padding type for the bottom side
	type,:	the new padding type

Returns:: Returns no value.

void ewl_object_padding_type_left_set	(	Ewl_Object *	o,
		Ewl_Padding_Type	type
	)

Set the padding type for the left side.

Parameters:

	o,:	the object to change the padding type for the left side
	type,:	the new padding type

Returns:: Returns no value.

void ewl_object_padding_type_right_set	(	Ewl_Object *	o,
		Ewl_Padding_Type	type
	)

Set the padding type for the right side.

Parameters:

	o,:	the object to change the padding type for the right side
	type,:	the new padding type

Returns:: Returns no value.

void ewl_object_padding_type_set	(	Ewl_Object *	o,
		Ewl_Padding_Type	type
	)

Set the padding type for all sides.

Parameters:

	o,:	the object to change the padding type
	type,:	the new padding type

Returns:: Returns no value.

void ewl_object_padding_type_top_set	(	Ewl_Object *	o,
		Ewl_Padding_Type	type
	)

Set the padding type for the top side.

Parameters:

	o,:	the object to change the padding type for the top side
	type,:	the new padding type

Returns:: Returns no value.

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.

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.

int ewl_object_preferred_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.

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.

void ewl_object_preferred_inner_h_set	(	Ewl_Object *	o,
		int	h
	)

Set the preferred height of the object.

Parameters:

	o,:	the object to change preferred height
	h,:	the value to use as the preferred height

Returns:: Returns no value.

Sets the preferred of o height to w or as close as possible according to the bounds.

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.

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.

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.

void ewl_object_preferred_inner_w_set	(	Ewl_Object *	o,
		int	w
	)

Set the preferred width of the object.

Parameters:

	o,:	the object to change preferred width
	w,:	the value to use as the preferred width

Returns:: Returns no value.

Sets the preferred of o width to w or as close as possible according to the bounds.

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.

int ewl_object_preferred_w_get ( Ewl_Object * o )

Get the preferred width of the object.

Parameters:

o,:

the object to retrieve the preferred width

Returns:: Returns the preferred width of the object o.

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.

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.

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.

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.

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

Detailed Description

Tutorial

Data Structures

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

Function Documentation