imglist.h File Reference

This file represents an ImageNode and ImageList interface. More...

Go to the source code of this file.

Classes
struct	ImgNode
	The ImageNode structure. More...
struct	ImgList
	The ImageList structure. More...
Functions
void	setMessage (char *m)
	Refreshes and shows message on UI.
ImgNode *	imgnode_alloc (Frame *f, int delay, int frame_duration)
	Creates a new ImageNode.
void	imgnode_dispose (ImgNode *i)
	Disposes an ImageNode.
ImgList *	imglist_alloc (void)
	Creates a new ImageList.
void	insert_first_frame (ImgList *imgl)
	Creates and inserts the first frame.
void	insert_frame_from_imagefile (ImgList *imgl, char *fname)
	Inserts a frame from image file (RAS or JPG).
void	insert_frame_from_jpgfile (ImgList *imgl, char *fname)
	Inserts a frame from JPG image file.
Frame *	get_empty_frame ()
	Creates an empty frame.
Frame *	get_frame_from_rasfile (char *image_path)
	Creates a frame from image RAS file.
Image *	imglist_peek_current_img (ImgList *q)
	Gets the current image in the ImageList.
int	imglist_isempty (ImgList *q)
	Returns true if the ImageList is empty, false otherwise.
void	imglist_insert (ImgList *q, ImgNode *i)
	Inserts an ImageNode in the ImageList.
void	imglist_overwrite (ImgList *q, ImgNode *i)
	Overwrites an ImageNode in the ImageList.
void	imglist_addimg (ImgList *q, ImgNode *i)
	Adds or overwrites an ImageNode according to the ImageList insert_on flag.
void	imglist_removeInRange (ImgList *q, int begin, int end)
	Removes the current ImageNode in the ImageList.
void	imglist_clear (ImgList *q)
	Clears an ImageList.
void	imglist_dispose (ImgList *q)
	Disposes an ImageList.
void	imglist_step (ImgList *q, int step)
	Forwards/Backwards the current ImageNode in the ImageList using step.
void	imglist_step_foward (ImgList *q)
	Forwards the current ImageNode in the ImageList.
void	imglist_step_backward (ImgList *q)
	Backwards the current ImageNode in the ImageList.
void	imglist_rew (ImgList *q)
	Rewinds an ImageList.
void	imglist_go_to_end (ImgList *q)
	Goes to the end of the ImageList.
void	imglist_update_frames (ImgList *q)
	Updates all the ImageNodes frame number, frame_pos and time_stamp in the ImageList.
void	imglist_go_to_frame (ImgList *q, int frameNumber)
	Shows a desired frame.
void	imglist_insert_at (ImgList *q, ImgNode *i)
	Inserts an ImageNode at a desired place.
int	imglist_getTotalFrames (ImgList *q)
	Gets the total of frames in an ImageList.
int	imglist_getTotalRealFrames (ImgList *q)
	Calculate the total of real frames (frame*duration) in an ImageList.
void	imglist_setFrameDuration (ImgList *q, int begin, int end, int duration)
	Sets the current frame duration.

---

Detailed Description

This file represents an ImageNode and ImageList interface.

---

Function Documentation

Frame* get_empty_frame

(

)

Creates an empty frame.

Returns:

The created frame.

Frame* get_frame_from_rasfile

(

char *

image_path

)

Creates a frame from image RAS file.

Parameters:

fname

image file name.

Returns:

The created frame.

void imglist_addimg	(	ImgList *	q,
		ImgNode *	i
	)

Adds or overwrites an ImageNode according to the ImageList insert_on flag.

Parameters:

	q	the ImageList.
	i	the ImageNode to be inserted.

ImgList* imglist_alloc

(

void

)

Creates a new ImageList.

Returns:

The ImageList.

void imglist_clear

(

ImgList *

q

)

Clears an ImageList.

Parameters:

q

the ImageList.

void imglist_dispose

(

ImgList *

q

)

Disposes an ImageList.

Parameters:

q

the ImageList.

int imglist_getTotalFrames

(

ImgList *

q

)

Gets the total of frames in an ImageList.

Parameters:

q

the ImageList

Returns:

The number of frames in an ImageList.

int imglist_getTotalRealFrames

(

ImgList *

q

)

Calculate the total of real frames (frame*duration) in an ImageList.

Parameters:

q

the ImageList

Returns:

The number of frames in an ImageList.

void imglist_go_to_end

(

ImgList *

q

)

Goes to the end of the ImageList.

Parameters:

q

the ImageList.

void imglist_go_to_frame	(	ImgList *	q,
		int	frameNumber
	)

Shows a desired frame.

Parameters:

	q	the image list.
	frameNumber	the desired frame number.

void imglist_insert	(	ImgList *	q,
		ImgNode *	i
	)

Inserts an ImageNode in the ImageList.

Parameters:

	q	the ImageList.
	i	the ImageNode to be inserted.

void imglist_insert_at	(	ImgList *	q,
		ImgNode *	i
	)

Inserts an ImageNode at a desired place.

The place is identified by the frame_number at the ImageNode to be inserted.

Parameters:

	q	the imageList.
	i	the imageNode to be inserted.

int imglist_isempty

(

ImgList *

q

)

Returns true if the ImageList is empty, false otherwise.

Parameters:

q

the ImageList.

Returns:

true if the ImageList is empty, false otherwise.

void imglist_overwrite	(	ImgList *	q,
		ImgNode *	i
	)

Overwrites an ImageNode in the ImageList.

Parameters:

	q	the ImageList.
	i	the ImageNode to be inserted.

Image* imglist_peek_current_img

(

ImgList *

q

)

Gets the current image in the ImageList.

Parameters:

q

the ImageList.

Returns:

The current image.

void imglist_removeInRange	(	ImgList *	q,
		int	begin,
		int	end
	)

Removes the current ImageNode in the ImageList.

Parameters:

q

the ImageList.

void imglist_rew

(

ImgList *

q

)

Rewinds an ImageList.

Parameters:

q

the ImageList.

void imglist_setFrameDuration	(	ImgList *	q,
		int	begin,
		int	end,
		int	duration
	)

Sets the current frame duration.

Parameters:

	begin	the begin of the range where to set the new duration.
	end	the end of the range where to set the new duration.
	duration	the new duration.
	q	the ImageList

void imglist_step	(	ImgList *	q,
		int	step
	)

Forwards/Backwards the current ImageNode in the ImageList using step.

Parameters:

	q	the ImageList.
	step	the number to increment/decrement current ImageNode position.

void imglist_step_backward

(

ImgList *

q

)

Backwards the current ImageNode in the ImageList.

Parameters:

q

the ImageList.

void imglist_step_foward

(

ImgList *

q

)

Forwards the current ImageNode in the ImageList.

Parameters:

q

the ImageList.

void imglist_update_frames

(

ImgList *

q

)

Updates all the ImageNodes frame number, frame_pos and time_stamp in the ImageList.

Parameters:

q

the ImageList.

ImgNode* imgnode_alloc	(	Frame *	f,
		int	delay,
		int	frame_duration
	)

Creates a new ImageNode.

Parameters:

	f	an ImageNode Frame attribute.
	delay	an ImageNode delay attribute.

Returns:

The ImageNode.

void imgnode_dispose

(

ImgNode *

i

)

Disposes an ImageNode.

Parameters:

i

the ImageNode to be deleted..

void insert_first_frame

(

ImgList *

imgl

)

Creates and inserts the first frame.

Parameters:

imgl

imageList where the first frame will be inserted.

void insert_frame_from_imagefile	(	ImgList *	imgl,
		char *	fname
	)

Inserts a frame from image file (RAS or JPG).

Parameters:

	imgl	imageList where the frame will be inserted.
	fname	image file name.

void insert_frame_from_jpgfile	(	ImgList *	imgl,
		char *	fname
	)

Inserts a frame from JPG image file.

Parameters:

	imgl	imageList where the frame will be inserted.
	fname	image file name.

void setMessage

(

char *

m

)

Refreshes and shows message on UI.

Parameters:

m

The message

---