Main Page   Data Structures   File List   Data Fields   Globals   Related Pages  

C_SSA Class Reference

Main Data Storage Class. More...

#include <C_SSA.h>


Public Member Functions

 C_SSA (void)
 Constructor.

 ~C_SSA (void)
 Destructor.

void Parse_SSA_File (char *filename)
 Parse a .ssa File into memory.

void SaveSSA_File (char *filename)
 Save lists.

void Clear ()
 Destroy all.

void Show_Event_List (C_ListView *myList)
 Show the events list.

void Show_Events_Edit_Fields (int index, C_Text_Edit EditText, C_Text_Edit Start, C_Text_Edit End, C_Text_Edit Duration, C_Text_Edit Margins, C_Combo_List Style, C_Combo_List Name)
 Show an event's information.

void Apply_Events_Modifications (C_Text_Edit EditText, C_Text_Edit Start, C_Text_Edit End, C_Text_Edit Margins, C_Combo_List Style, C_Combo_List Name, C_ListView myList)
 Put information of the Edit field into an event.

C_Events_ListApply_Events_Modifications (int index, char *Text, char *Start, char *End, char *Margins, char *Style, char *Name)
 Update an event with gived informations.

void Show_Style_List (C_Combo_List Combo)
 Show the events list.

void Show_Name_List (C_Combo_List Combo)
 Show The Personnages name.

void Add_Event (int ID)
 Add an Event.

void Swap_Event (int ID)
 Swap 2 folowing events.

void Split_Event (int ID)
 Split an event in 2 event.

void Join_Event (int ID)
 Join 2 folowing events.

void Delete_Event (int ID)
 Delete an event from the list.

void Update_List_Event (int ID, C_ListView *myList)
 Update an event of the list.

void Update_List_View_ID (C_ListView myList)
 Update le ID subitem of the list view.

void GetCollisionsID (int ID, int *Table)
 Get the ID of the event wich are in collisions with the ID.


Data Fields

C_Style_SheetFirst_Style
 Link for the Styles List.

C_Events_ListFirst_Event
 Link for the Events List.

C_Name_ListFirst_Name
 Link for the Personnage Names List.

char * Title
 Title of the Subbed movie.

char * Fansub_team
 Name of the Original Fansub Team.

char * Translator
 Name of the translator of the movie.

char * Editor
 Name of the editor of the movie.

char * Timer
 Name of the Timer of the movie.

char * Checker
 Name of the checker of the movie.

int Script_Version
 Vertsion of the script (normaly 4.00), not used yet.

int Collisions_type
 Type of SSA Collision (see ASS documentation).

int PlayResY
 Maybe.

int PlayDepth
 Maybe the zoom for the timing ramp.

char * Lastwav
 Name of the last Used wav file, not used yet.

float Timer_Precision
 Precision of the timer (normaly 100,00).


Detailed Description

Main Data Storage Class.

This Class Concentrate the Link of all Storages list (Style, Events and Personnage Names). It also begin the parsing of subtitles files.

Todo:
The collision detector.

The find function.

The replace function.

The cut/copy/past event gestion.

The srt file parser

The sub file parser


Constructor & Destructor Documentation

C_SSA::C_SSA void   ) 
 

Constructor.

Set to 0 all the class (memset my friend)

C_SSA::~C_SSA void   ) 
 

Destructor.

See also:
Clear()


Member Function Documentation

void C_SSA::Add_Event int  ID  ) 
 

Add an Event.

Add an event to the ID position, if there is an event at this place, it's puted after Only applied in the memory list

Parameters:
ID id of the event (index list +1)

C_Events_List * C_SSA::Apply_Events_Modifications int  index,
char *  Text,
char *  Start,
char *  End,
char *  Margins,
char *  Style,
char *  Name
 

Update an event with gived informations.

It's used to Edit the Events, only use this function (overload it if you need)

Parameters:
index ID of the events
Text The text to put in the event
Start The starting time of the event
End The ending time of the event
Margins The char wich contain the margins
Style Name of the style
Name Personnage's name
Returns:
The modified element of the event list

void C_SSA::Apply_Events_Modifications C_Text_Edit  EditText,
C_Text_Edit  Start,
C_Text_Edit  End,
C_Text_Edit  Margins,
C_Combo_List  Style,
C_Combo_List  Name,
C_ListView  myList
 

Put information of the Edit field into an event.

It's used to Edit the Events, only use this function (overload it if you need)

Parameters:
EditText C_Text_Edit class where to show the Text(dialogue) of the event
Start C_Text_Edit class where to show the begining time
End C_Text_Edit class where to show the ending time
Margins C_Text_Edit class where the text is displayed.
Style C_Combo_List class where the Styles are loaded
Name C_Combo_List class where the Personnage's name are loaded

void C_SSA::Clear  ) 
 

Destroy all.

Desalouate all the lists and clean all the data members (called by the destructor)

void C_SSA::Delete_Event int  ID  ) 
 

Delete an event from the list.

Delete an event from the list in memory, not from the list view

Parameters:
ID id of the event to delete (id = index + 1)

void C_SSA::GetCollisionsID int  ID,
int *  Table
 

Get the ID of the event wich are in collisions with the ID.

Parameters:
ID ID of the event, it is used to find collisions.
Table pointer to a table of 256 elements.

void C_SSA::Join_Event int  ID  ) 
 

Join 2 folowing events.

Join the event ID and ID + 1, if the personnage name and the style are different, the style or the personnage name is selected for the final event. For the margins, this is the average of the 2 events. It's applied only on the memory list

Parameters:
ID id of the event (id = index of the listview +1)

void C_SSA::Parse_SSA_File char *  filename  ) 
 

Parse a .ssa File into memory.

Parameters:
filename Path and filename of the .ssa file.

void C_SSA::SaveSSA_File char *  filename  ) 
 

Save lists.

Save all the lists wich are in memory into a .ssa file.

Parameters:
filename Path and filename of the .ssa file.

void C_SSA::Show_Event_List C_ListView myList  ) 
 

Show the events list.

Show all the events list, begining by First_Event into a listview

Parameters:
*myList Pointer to a C_ListView Class
See also:
First_Events

void C_SSA::Show_Events_Edit_Fields int  index,
C_Text_Edit  EditText,
C_Text_Edit  Start,
C_Text_Edit  End,
C_Text_Edit  Duration,
C_Text_Edit  Margins,
C_Combo_List  Style,
C_Combo_List  Name
 

Show an event's information.

Show event's index information into few fields to edit this information

Parameters:
index ID of the event to show
EditText C_Text_Edit class where to show the Text(dialogue) of the event
Start C_Text_Edit class where to show the begining time
End C_Text_Edit class where to show the ending time
Duration C_Text_Edit class where to show the Duration of the event (calculate by the member).
Margins C_Text_Edit class where to show The margins value.
Style C_Combo_List class where the Styles are loaded, the members select the event's style
Name C_Combo_List class where the Personnage's name are loaded, the members select the events's name

void C_SSA::Show_Name_List C_Combo_List  Combo  ) 
 

Show The Personnages name.

Show all the Personnages Name into a Combo box

Parameters:
Combo a C_Combo_List where to show the name list
See also:
First_Name

void C_SSA::Show_Style_List C_Combo_List  Combo  ) 
 

Show the events list.

Show all the style list, begining by First_Event into a listview

Parameters:
Combo A C_Combo_List Class where show the style list
See also:
First_Style

void C_SSA::Split_Event int  ID  ) 
 

Split an event in 2 event.

The time is divided by 2, and the text, it take the middle of the string and advance to the next space, if there is a , it. Only applied in memory list

Parameters:
ID id of the event (id = index of the listview +1)

void C_SSA::Swap_Event int  ID  ) 
 

Swap 2 folowing events.

Swap the event ID and ID + 1. Only applied in memory list

Parameters:
ID id of the event (id = index of the list view +1)

void C_SSA::Update_List_Event int  ID,
C_ListView myList
 

Update an event of the list.

Parameters:
ID id of the event (in memory, not the index [id = index + 1])
myList A C_List_View class where display the event

void C_SSA::Update_List_View_ID C_ListView  myList  ) 
 

Update le ID subitem of the list view.

Parameters:
myList C_List_View List contening required fields


Field Documentation

char* C_SSA::Checker
 

Name of the checker of the movie.

int C_SSA::Collisions_type
 

Type of SSA Collision (see ASS documentation).

Not used yet

char* C_SSA::Editor
 

Name of the editor of the movie.

char* C_SSA::Fansub_team
 

Name of the Original Fansub Team.

C_Events_List* C_SSA::First_Event
 

Link for the Events List.

See also:
C_Events_List

C_Name_List* C_SSA::First_Name
 

Link for the Personnage Names List.

See also:
C_Name_List

C_Style_Sheet* C_SSA::First_Style
 

Link for the Styles List.

See also:
C_Style_Sheet

char* C_SSA::Lastwav
 

Name of the last Used wav file, not used yet.

int C_SSA::PlayDepth
 

Maybe the zoom for the timing ramp.

int C_SSA::PlayResY
 

Maybe.

int C_SSA::Script_Version
 

Vertsion of the script (normaly 4.00), not used yet.

char* C_SSA::Timer
 

Name of the Timer of the movie.

float C_SSA::Timer_Precision
 

Precision of the timer (normaly 100,00).

Not used yet.

char* C_SSA::Title
 

Title of the Subbed movie.

char* C_SSA::Translator
 

Name of the translator of the movie.


The documentation for this class was generated from the following files:
Generated on Thu Jul 3 15:19:54 2003 for Sub Station Beta by doxygen1.3