Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals

Engrave_Part: Functions to work with part objects


Data Structures

struct  _Engrave_Part
 All values needed to define a part. More...


Typedefs

typedef _Engrave_Part Engrave_Part
 The Engrave_Part typedef.


Functions

Engrave_Partengrave_part_new (Engrave_Part_Type type)
 engrave_part_new - create a new part object.

void engrave_part_free (Engrave_Part *ep)
 engrave_part_free - free the part

void engrave_part_parent_set (Engrave_Part *ep, void *eg)
 engrave_part_parent_set - set the parent pointer in the part

void * engrave_part_parent_get (Engrave_Part *ep)
 engrave_part_parent_get - get the parent pointer for the part

void engrave_part_name_set (Engrave_Part *ep, const char *name)
 engrave_part_name_set - set the name of the part.

void engrave_part_mouse_events_set (Engrave_Part *ep, int val)
 engrave_part_mouse_events_set - set the mouse events flag for the part.

void engrave_part_repeat_events_set (Engrave_Part *ep, int val)
 engrave_part_repeat_events_set - set the repeat events flag for the part.

void engrave_part_type_set (Engrave_Part *ep, Engrave_Part_Type type)
 engrave_part_type_set - set the type of the part

void engrave_part_effect_set (Engrave_Part *ep, Engrave_Text_Effect effect)
 engrave_part_effect_set - set the effect on the given part.

void engrave_part_clip_to_set (Engrave_Part *ep, const char *clip_to)
 engrave_part_clip_set - set the clip of the given part.

Engrave_Part_Stateengrave_part_state_last_get (Engrave_Part *ep)
 engrave_part_state_last_get - get the last state in the part.

void engrave_part_dragable_x_set (Engrave_Part *ep, int x, int step, int count)
 engrave_part_dragable_x_set - set the dragable x value on the part.

void engrave_part_dragable_y_set (Engrave_Part *ep, int y, int step, int count)
 engrave_part_dragable_y_set - set the dragable y value on the part.

void engrave_part_dragable_confine_set (Engrave_Part *ep, const char *confine)
 engrave_part_dragable_confine_set - set the confine of the parts dragable.

void engrave_part_state_add (Engrave_Part *ep, Engrave_Part_State *eps)
 engrave_part_state_add - add the state to the part.

Engrave_Part_Stateengrave_part_state_by_name_value_find (Engrave_Part *ep, const char *name, double val)
 engrave_part_state_by_name_value_find - Find the Engrave_Part State that * matches the given name and value in this part

const char * engrave_part_name_get (Engrave_Part *ep)
 engrave_part_name_get - Get the name of the part

Engrave_Part_Type engrave_part_type_get (Engrave_Part *ep)
 engrave_part_type_get - Get the type of the part

int engrave_part_mouse_events_get (Engrave_Part *ep)
 engrave_part_mouse_events_get - Get the mouse events setting

int engrave_part_repeat_events_get (Engrave_Part *ep)
 engrave_part_repeat_events_get - Get the repeat events setting

Engrave_Text_Effect engrave_part_effect_get (Engrave_Part *ep)
 engrave_part_effect_get - Get the text effect on the part

const char * engrave_part_clip_to_get (Engrave_Part *ep)
 engrave_part_clip_to_get - Get the clip_to setting of the part

void engrave_part_dragable_x_get (Engrave_Part *ep, int *x, int *step, int *count)
 engrave_part_dragable_x_get - Get the dragable info in the x direction

void engrave_part_dragable_y_get (Engrave_Part *ep, int *y, int *step, int *count)
 engrave_part_dragable_y_get - Get the dragable info in the y direction

const char * engrave_part_dragable_confine_get (Engrave_Part *ep)
 engrave_part_dragable_confine_get - Get the dragable confine setting

int engrave_part_states_count (Engrave_Part *ep)
 engrave_part_states_count - get number of states in the part

void engrave_part_state_foreach (Engrave_Part *ep, void(*func)(Engrave_Part_State *, Engrave_Part *, void *), void *data)
 engrave_part_state_foreach - iterate over each of the states in the part


Function Documentation

const char* engrave_part_clip_to_get Engrave_Part ep  ) 
 

engrave_part_clip_to_get - Get the clip_to setting of the part

Parameters:
ep: The Engrave_Part to get the clip_to from
Returns:
Returns the clip_to string for the part or NULL on failure.

void engrave_part_clip_to_set Engrave_Part ep,
const char *  clip_to
 

engrave_part_clip_set - set the clip of the given part.

Parameters:
ep: The Engrave_Part to set the clip on
clip_to: The name of the part to clip too.
Returns:
Returns no value.

const char* engrave_part_dragable_confine_get Engrave_Part ep  ) 
 

engrave_part_dragable_confine_get - Get the dragable confine setting

Parameters:
ep: The Engrave_Part to get the confine setting from
Returns:
Returns the confine setting or NULL on failure.

void engrave_part_dragable_confine_set Engrave_Part ep,
const char *  confine
 

engrave_part_dragable_confine_set - set the confine of the parts dragable.

Parameters:
ep: The Engrave_Part to confine the dragable on.
confine: The name of the part to confine the dragable to.
Returns:
Returns no value.

void engrave_part_dragable_x_get Engrave_Part ep,
int *  x,
int *  step,
int *  count
 

engrave_part_dragable_x_get - Get the dragable info in the x direction

Parameters:
ep: The Engrave_Part to get the dragable information from
x: Where to place the x value
step: Where to place the step value
count: Where to place the count value
Returns:
Returns no value.

void engrave_part_dragable_x_set Engrave_Part ep,
int  x,
int  step,
int  count
 

engrave_part_dragable_x_set - set the dragable x value on the part.

Parameters:
ep: The Engrave_Part to set the x dragable on.
x: The x value to set on the dragable.
step: The step value to set on the dragable.
count: The count value to set on the dragable.
Returns:
Returns no value.

void engrave_part_dragable_y_get Engrave_Part ep,
int *  y,
int *  step,
int *  count
 

engrave_part_dragable_y_get - Get the dragable info in the y direction

Parameters:
ep: The Engrave_Part to get the dragable information from
y: Where to place the y value
step: Where to place the step value
count: Where to place the count value
Returns:
Returns no value.

void engrave_part_dragable_y_set Engrave_Part ep,
int  y,
int  step,
int  count
 

engrave_part_dragable_y_set - set the dragable y value on the part.

Parameters:
ep: The Engrave_Part to set the y dragable on.
y: The y value to set on the dragable.
step: The step value to set on the dragable.
count: The count value to set on the dragable.
Returns:
Returns no value.

Engrave_Text_Effect engrave_part_effect_get Engrave_Part ep  ) 
 

engrave_part_effect_get - Get the text effect on the part

Parameters:
ep: The Engrave_Part to get the effect from
Returns:
Returns the Engrave_Text_Effect setting for the part or ENGRAVE_TEXT_EFFECT_NONE if non set

void engrave_part_effect_set Engrave_Part ep,
Engrave_Text_Effect  effect
 

engrave_part_effect_set - set the effect on the given part.

Parameters:
ep: The Engrave_Part to set the effect upon.
effect: The Engrave_Text_Effect to set on the part.
Returns:
Returns no value.

void engrave_part_free Engrave_Part ep  ) 
 

engrave_part_free - free the part

Parameters:
ep: The Engrave_Part to free
Returns:
Returns no value.

int engrave_part_mouse_events_get Engrave_Part ep  ) 
 

engrave_part_mouse_events_get - Get the mouse events setting

Parameters:
ep: The Engrave_Part to get the mouse events from
Returns:
Returns the mouse events setting for the part

void engrave_part_mouse_events_set Engrave_Part ep,
int  val
 

engrave_part_mouse_events_set - set the mouse events flag for the part.

Parameters:
ep: The Engrave_Part to set the mouse events flag on.
val: The value to set the mouse events flag too.
Returns:
Returns no value.

const char* engrave_part_name_get Engrave_Part ep  ) 
 

engrave_part_name_get - Get the name of the part

Parameters:
ep: The Engrave_Part to retrieve the name from.
Returns:
Returns the name of the part, or NULL on failure.

void engrave_part_name_set Engrave_Part ep,
const char *  name
 

engrave_part_name_set - set the name of the part.

Parameters:
ep: The Engrave_Part to set the name off
name: The name to attach to the part.
Returns:
Returns no value.

Engrave_Part* engrave_part_new Engrave_Part_Type  type  ) 
 

engrave_part_new - create a new part object.

Parameters:
type: The Engrave_Part_Type for the part.
Returns:
Returns a pointer to the newly allocated Engrave_Part on sucess or NULL on failure.

void* engrave_part_parent_get Engrave_Part ep  ) 
 

engrave_part_parent_get - get the parent pointer for the part

Parameters:
ep: The Engrave_Part to get the parent from
Returns:
Returns the Engrave_Group pointer if set, or NULL if none set.

void engrave_part_parent_set Engrave_Part ep,
void *  eg
 

engrave_part_parent_set - set the parent pointer in the part

Parameters:
ep: The Engrave_Part to set the pointer into
eg: The Engrave_Group to set as parent
Returns:
Returns no value.

int engrave_part_repeat_events_get Engrave_Part ep  ) 
 

engrave_part_repeat_events_get - Get the repeat events setting

Parameters:
ep: The Engrave_Part to get the repeat event setting from
Returns:
Returns the repeat event setting of the part

void engrave_part_repeat_events_set Engrave_Part ep,
int  val
 

engrave_part_repeat_events_set - set the repeat events flag for the part.

Parameters:
ep: The Engrave_Part to set the repeat events flag on.
val: The value to set the repeat events flag too.
Returns:
Returns no value.

void engrave_part_state_add Engrave_Part ep,
Engrave_Part_State eps
 

engrave_part_state_add - add the state to the part.

Parameters:
ep: The Engrave_Part to add the state too.
eps: The Engrave_Part_State to add to the part.
Returns:
Returns no value.

Engrave_Part_State* engrave_part_state_by_name_value_find Engrave_Part ep,
const char *  name,
double  val
 

engrave_part_state_by_name_value_find - Find the Engrave_Part State that * matches the given name and value in this part

Parameters:
ep: The Engrave_Part to search.
name: The name to search for
val: The value to search for.
Returns:
Returns a pointer to the Engrave_Part_State matching the given criteria or NULL if not found.

void engrave_part_state_foreach Engrave_Part ep,
void(*  func)(Engrave_Part_State *, Engrave_Part *, void *),
void *  data
 

engrave_part_state_foreach - iterate over each of the states in the part

Parameters:
ep: The Engrave_Part to get the states from
func: The function to call for each state
data: The user data
Returns:
Returns no value.

Engrave_Part_State* engrave_part_state_last_get Engrave_Part ep  ) 
 

engrave_part_state_last_get - get the last state in the part.

Parameters:
ep: The Engrave_Part to retrieve the state from.
Returns:
Returns the last Engrave_Part_State value in the part or NULL if no such value exists.

int engrave_part_states_count Engrave_Part ep  ) 
 

engrave_part_states_count - get number of states in the part

Parameters:
ep: The Engrave_Part to check
Returns:
Returns number of states in the part, 0 otherwise.

Engrave_Part_Type engrave_part_type_get Engrave_Part ep  ) 
 

engrave_part_type_get - Get the type of the part

Parameters:
ep: The Engrave_Part to get the type from
Returns:
Returns the Engrave_Part_Type of the part

void engrave_part_type_set Engrave_Part ep,
Engrave_Part_Type  type
 

engrave_part_type_set - set the type of the part

Parameters:
ep: The Engrave_Part to set the type on.
type: The Engrave_Part_Type to set on the part
Returns:
Returns no value.