---

C_Events_List Class Reference

Data storage for the events. More...

#include <C_Events_List.h>

Public Member Functions
	C_Events_List (void)
	The constructor.
	~C_Events_List (void)
	The destructor.
void	Parse_Event (C_Style_Sheet *First, char *line, char *format, C_Name_List *First_Name)
	Parse an event readed in a .ssa file.
char *	MarginTostring (void)
	Convert Margins value to a string.
char *	Tostring (char *format)
	Convert the element to a string.
void	ParseMargin (char *Line)
	Parse a string into margin value.
void	Parse_Event_Format (char *line, char *Source)
	Parse a Event format line.
Data Fields
C_Events_List *	Next
	Link to the Next Event (it's evident no?).
C_Style_Sheet *	Style
	Link to the associated style.
int	Event_Type
	Type of the event.
int	Effect
	Effect applied to the event.
int	MarginL
	Left Margin of the Event.
int	MarginR
	Right Margin of the Event.
int	MarginV
	Vertical Margin of the Event.
int	Marked
	I don't know :|.
C_Name_List *	Personnage_Name
	Link to a personnage name.
char *	Text
	Text (dialog) of the event.
SSA_Time	Start
	Starting Time of the event.
SSA_Time	End
	Ending Time of the event.
SSA_Time	Duration
	Duration Time of the event (calculated).
long	ID
	ID of the event (index).

---

Detailed Description

Data storage for the events.

This class stock all data concerning an event (list)

---

Constructor & Destructor Documentation

C_Events_List::C_Events_List (  void   )

The constructor. Only put at 0 the class (and the ID to -1)

C_Events_List::~C_Events_List (  void   )

The destructor. Desalouate all allocated string (like Text) See also: Text

---

Member Function Documentation

char * C_Events_List::MarginTostring (  void   )

Convert Margins value to a string. Convert the MarginL, MarginR and MarginV value to a string to be displayed You MUST delete[] the data when finish See also: MarginL MarginR MarginV

void C_Events_List::Parse_Event (  C_Style_Sheet *  First, char *  line, char *  format, C_Name_List *  First_Name )

Parse an event readed in a .ssa file. Parameters: First  Link to the first element of the style list, to find the needed one line  Line contening the data to parse format  Pointer to the string created by Parse_Event_Format First_Name  Pointer to the first element of the name list, to point needed or to add one otherwise See also: Parse_Event_Format() C_SSA::Parse_SSA_File()

void C_Events_List::Parse_Event_Format (  char *  line, char *  Source )

Parse a Event format line. Parse a line of formating, generaly the first line of a section it's utilised after by Parse_Event() Parameters: line  Pointer to a string contening the line to parse Source  Pointer to an initializated string wich will receive the data See also: Parse_Event()

void C_Events_List::ParseMargin (  char *  Line  )

Parse a string into margin value. Parse a string formated like MarginTostring() Line char to parse See also: MarginTostring()

char * C_Events_List::Tostring (  char *  format  )

Convert the element to a string. Parameters: format  a pointer to a char wich contain the event format (returned by Parse_Event_Format by exemple) Returns: The string formated by *format See also: Parse_Event_Format()

---

Field Documentation

SSA_Time C_Events_List::Duration

Duration Time of the event (calculated).

int C_Events_List::Effect

Effect applied to the event. It can be Karaoke, Banner or Scrollup See also: EFFECT_KARAOKE EFFECT_BANNER EFFECT_SCROLLUP

SSA_Time C_Events_List::End

Ending Time of the event.

int C_Events_List::Event_Type

Type of the event. The event can be a : Dialogue, Comment, Picture, Sound, Movie or a Command See also: SSA_DIALOGUE_EVENT SSA_COMMENT_EVENT SSA_PICTURE_EVENT SSA_SOUND_EVENT SSA_MOVIE_EVENT SSA_COMMAND_EVENT

long C_Events_List::ID

ID of the event (index).

int C_Events_List::MarginL

Left Margin of the Event.

int C_Events_List::MarginR

Right Margin of the Event.

int C_Events_List::MarginV

Vertical Margin of the Event.

int C_Events_List::Marked

I don't know :|.

C_Events_List* C_Events_List::Next

Link to the Next Event (it's evident no?).

C_Name_List* C_Events_List::Personnage_Name

Link to a personnage name. See also: C_Name_List

SSA_Time C_Events_List::Start

Starting Time of the event.

C_Style_Sheet* C_Events_List::Style

Link to the associated style. See also: C_Style_Sheet

char* C_Events_List::Text

Text (dialog) of the event.

---

The documentation for this class was generated from the following files:

• C_Events_List.h
• C_Events_List.cpp

---