class Parameters

This class holds all parameters for the presentation

Public Fields

[more]char* input_file_
The name of the inputfile
[more]char* path_to_themes_
The path to the directory which contains all themes
[more]char* theme_
The theme that will be used for the presentation
[more]char* target_directory_
The target-directory where the presentation-files will be written
[more]int resolution_
The screen-resolution
[more]int enable_background_graphic_
1, if the background-graphic for the slide should be enabled, else 0
[more]int enable_header_graphic_
1, if the background-graphic for the header should be enabled, else 0
[more]int enable_footer_graphic_
1, if the background-graphic for the footer should be enabled, else 0
[more]ImageSize* prev_
The dimensions of the previous-button
[more]ImageSize* next_
The dimensions of the next-button
[more]ImageSize* slide_
The dimensions of the background-graphic for the slide
[more]ImageSize* header_
The dimensions of the background-graphic for the header
[more]ImageSize* footer_
The dimensions of the background-graphic for the footer

Public Methods

[more] Parameters()
Default constructor which initializes the parameters to default-values.
[more] ~Parameters()
Destructor
[more]int readConfigFile(const char *filename)
This method reads the given config-file and updates the parameters
[more]void setPathToThemes(const char *path_to_themes)
This method will set the path to the directory, which contains all themes
[more]void setTheme(const char *theme)
This method will set the theme that should be used for the presentation
[more]void setTargetDirectory(const char *target_directory)
This method will set the target-directory, where all presentation-files will be written
[more]int initPathToTheme()
This method initializes the path to the theme
[more]void initImageSizes()
This method initializes the sizes of the background-images
[more]char* getPathToTheme()
This method returns the path to the selected theme

Private Fields

[more]ostrstream* path_to_theme_
The path to the selected theme


Documentation

This class holds all parameters for the presentation. This parameters will be initialized with hard-coded default-values. The values can be overridden by a global config-file, a user config-file (located in the user's home-directory) and by commandline-options.
o Parameters()
Default constructor which initializes the parameters to default-values.

o ~Parameters()
Destructor

oint readConfigFile(const char *filename)
This method reads the given config-file and updates the parameters.
Returns:
-1 if the file doesn't exist, 0 if everything is OK, else the number of errors in the config-file
Parameters:
filename - The name of the config-file

ovoid setPathToThemes(const char *path_to_themes)
This method will set the path to the directory, which contains all themes. A trailing '/' will be added if the parameter doesn't have one.
Parameters:
path_to_themes - The new path to the themes

ovoid setTheme(const char *theme)
This method will set the theme that should be used for the presentation.
Parameters:
theme - The new theme

ovoid setTargetDirectory(const char *target_directory)
This method will set the target-directory, where all presentation-files will be written. A trailing '/' will be added if the parameter doesn't have one.
Parameters:
target_directory - The new target-directory

oint initPathToTheme()
This method initializes the path to the theme. This method must be called after the config-file and the commandline-parameters are evaluated.
Returns:
0, if the theme exists, else -1

ovoid initImageSizes()
This method initializes the sizes of the background-images. This method must be called after the path to the theme was initialized.

ochar* getPathToTheme()
This method returns the path to the selected theme.
Returns:
The path to the selected theme

ochar* input_file_
The name of the inputfile

ochar* path_to_themes_
The path to the directory which contains all themes

ochar* theme_
The theme that will be used for the presentation

ochar* target_directory_
The target-directory where the presentation-files will be written

oint resolution_
The screen-resolution

oostrstream* path_to_theme_
The path to the selected theme

oint enable_background_graphic_
1, if the background-graphic for the slide should be enabled, else 0

oint enable_header_graphic_
1, if the background-graphic for the header should be enabled, else 0

oint enable_footer_graphic_
1, if the background-graphic for the footer should be enabled, else 0

oImageSize* prev_
The dimensions of the previous-button

oImageSize* next_
The dimensions of the next-button

oImageSize* slide_
The dimensions of the background-graphic for the slide

oImageSize* header_
The dimensions of the background-graphic for the header

oImageSize* footer_
The dimensions of the background-graphic for the footer


This class has no child classes.

Alphabetic index Hierarchy of classes



This page was generated with the help of DOC++.