class Parameters

This class holds all parameters for the presentation

Public Fields

[more]string xml_file_
The name of the XML-file
[more]Output_Format output_format_
The format of the output
[more]ImageSize* prev_
The dimensions of the previous-button
[more]ImageSize* next_
The dimensions of the next-button
[more]ImageSize* first_
The dimensions of the first-button
[more]ImageSize* last_
The dimensions of the last-button
[more]ImageSize* note_
The dimensions of the note-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]string default_config_file_
The config-file, which will be read and evaluated
[more]string cl_config_file_
The config-file given on the command-line
[more]string default_path_to_themes_
The default path to the directory which contains all themes
[more]string cf_path_to_themes_
The path to the themes set in the config-file
[more]string cl_path_to_themes_
The path to the themes set with the commandline-option -p
[more]string default_html_theme_
The default theme for the HTML-output
[more]string cf_html_theme_
The theme for the HTML-output set in the config-file
[more]string xml_html_theme_
The theme for the HTML-output set in the XML-file
[more]string cl_html_theme_
The theme for the HTML-output set with the commandline-option -t
[more]string full_path_to_theme_
The full path to the selected theme (path_to_themes_ + theme_)
[more]int default_disable_xml_settings_
1, if the settings stored in the XML-file should be disabled, else 1
[more]int cf_disable_xml_settings_
The disable-xml-settings option is : 1, if set to "yes" in the config-file
[more]int cl_disable_xml_settings_
1, if the commandline-option -x was given, else -1
[more]int default_html_resolution_
The default screen-resolution for the HTML-output
[more]int cf_html_resolution_
The screen-resolution for the HTML-output set in the config-file, or -1, if the screen-resolution is not given
[more]int xml_html_resolution_
The screen-resolution for the HTML-output set in the XML-file, or -1, if the screen-resolution is not given
[more]int cl_html_resolution_
1, if the screen-resolution for the HTML-output was set with the commandline-option -R, else -1
[more]int default_html_disable_background_graphic_
1, if the background-graphic for the slides should be disabled, else 0
[more]int cl_html_disable_background_graphic_
1, if the commandline-option -B was given, else -1
[more]int default_html_disable_header_graphic_
1, if the background-graphic for the header should be disabled, else 0
[more]int cl_html_disable_header_graphic_
1, if the commandline_option -H was given, else -1
[more]int default_html_disable_first_last_button_
1, if buttons to the first and last slide should be disabled, else 0
[more]int cl_html_disable_first_last_button_
1, if the commandline-option -F was given, else -1
[more]int default_html_disable_note_button_
1, if the note-button should be disabled, else 0
[more]int cl_html_disable_note_button_
1, if the commandline-option -N was given, else -1
[more]int default_html_sloppy_buttons_
0, if the buttons should be drawn at a fixed position
[more]int cf_html_sloppy_buttons_
The sloppy-buttons option is : 1, if set to "yes" in the config-file
[more]int xml_html_sloppy_buttons_
The sloppy-buttons option is : 1, if set to "yes" in the XML-file
[more]int cl_html_sloppy_buttons_
1, if the commandline-option -S was given, else -1
[more]int default_html_cell_padding_
The default-value of the table-attribute 'cellpadding' used in the grid-environment
[more]int xml_html_cell_padding_
The cellpadding option set in the XML-file, or -1 if not given
[more]int default_html_top_navigation_
1, if all navigation-buttons should be on the top of the slide, else 0
[more]int cf_html_top_navigation_
The top-navigation option is : 1, if set to "yes" in the config-file
[more]int xml_html_top_navigation_
The top-navigation option is : 1, if set to "yes" in the XML-file
[more]int cl_html_top_navigation_
1, if the commandline-option -T was given, else -1
[more]int default_latex_print_outline_
0, if the LaTeX-output should use the documentclass 'seminar'
[more]int cf_latex_print_outline_
The print-outline option is : 1, if set to "yes" in the config-file
[more]int xml_latex_print_outline_
The outline option is : 1, if set to "yes" in the XML-file
[more]int cl_latex_print_outline_
1, if the commandline parameter -O was given, else -1

Public Methods

[more] Parameters()
The constructor initializes the parameters to default-values
[more] ~Parameters()
Destructor
[more]int readConfigFile()
This method reads the config-file stored in the member-variable config_file_ and initializes the member_variables, which names start with cf_
[more]int initPathToTheme()
This method initializes the path to the selected theme, which is stored in a subdirectory of the theme-path
[more]void initImageSizes()
This method initializes the sizes of the background-images
[more]string& getConfigFile()
This method is used to determine the name of the config-file
[more]string getPathToThemes() const
This method is used to determine the path to the themes
[more]string& getTheme()
This method is used to determine the selected theme
[more]int isXMLSettingsDisabled() const
This method is used to determine, if the settings in the XML-file were be disabled
[more]int getResolution() const
This method is used to determine the resolution for the HTML-output
[more]int isSlideBackgroundEnabled() const
This method is used to determine, if the background-graphic for the slide is enabled or disabled
[more]int isHeaderBackgroundEnabled() const
This method is used to determine, if the background-graphic for the header is enabled or disabled
[more]int isFirstAndLastButtonEnabled() const
This method is used to determine, if the First- and Last-button is enabled or disabled
[more]int isNoteButtonEnabled() const
This method is used to determine, if the Note-button is enabled or disabled
[more]int isSloppyButtonsEnabled() const
This method is used to determine, if the sloppy-button option is enabled or disabled
[more]int getCellPadding() const
This method returns the value of the cellpadding-attribute for the HTML-table of the grid-environment
[more]int isTopNavigationEnabled() const
This method is used to determine, if the navigation-buttons should be placed on the top of each slide
[more]int isOutlineEnabled() const
This method is used to determine, if the LaTeX-output should be an outline


Documentation

This class holds all parameters for the presentation. The default-values for these parameters can be overridden by a config-file, by the presentation itself and by commandline-options.
o Parameters()
The constructor initializes the parameters to default-values.

o ~Parameters()
Destructor.

oint readConfigFile()
This method reads the config-file stored in the member-variable config_file_ and initializes the member_variables, which names start with cf_.

Returns:
-1, if the file doesn't exist, else the number of errors in the config-file

oint initPathToTheme()
This method initializes the path to the selected theme, which is stored in a subdirectory of the theme-path.

Returns:
0, if the theme exists. -1, if the theme-path wasn't initialized. -2, if the selected theme doesn't have the file "config".

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

ostring& getConfigFile()
This method is used to determine the name of the config-file.

Returns:
The name of the config-file.

ostring getPathToThemes() const
This method is used to determine the path to the themes.

Returns:
The path to the themes.

ostring& getTheme()
This method is used to determine the selected theme.

Returns:
the selected theme.

oint isXMLSettingsDisabled() const
This method is used to determine, if the settings in the XML-file were be disabled.

Returns:
1, if the XML-settings were disabled, else 0.

oint getResolution() const
This method is used to determine the resolution for the HTML-output.

Returns:
The resolution (800 or 1024).

oint isSlideBackgroundEnabled() const
This method is used to determine, if the background-graphic for the slide is enabled or disabled.

Returns:
1, if the background-graphic is enabled, else 0.

oint isHeaderBackgroundEnabled() const
This method is used to determine, if the background-graphic for the header is enabled or disabled.

Returns:
1, if the background-graphic is enabled, else 0.

oint isFirstAndLastButtonEnabled() const
This method is used to determine, if the First- and Last-button is enabled or disabled.

Returns:
1, if the First- and Last-button is enabled, else 0.

oint isNoteButtonEnabled() const
This method is used to determine, if the Note-button is enabled or disabled.

Returns:
1, if the Note-button is enabled, else 0.

oint isSloppyButtonsEnabled() const
This method is used to determine, if the sloppy-button option is enabled or disabled.

Returns:
1, if the sloppy-button option is enabled, else 0.

oint getCellPadding() const
This method returns the value of the cellpadding-attribute for the HTML-table of the grid-environment.

Returns:
The cellpadding-value.

oint isTopNavigationEnabled() const
This method is used to determine, if the navigation-buttons should be placed on the top of each slide.

Returns:
1, if the navigation-buttons should be on the top, else 0.

oint isOutlineEnabled() const
This method is used to determine, if the LaTeX-output should be an outline.

Returns:
1, if the LaTeX-output should be an outline, else 0.

ostring xml_file_
The name of the XML-file.

oOutput_Format output_format_
The format of the output.

oImageSize* prev_
The dimensions of the previous-button.

oImageSize* next_
The dimensions of the next-button.

oImageSize* first_
The dimensions of the first-button.

oImageSize* last_
The dimensions of the last-button.

oImageSize* note_
The dimensions of the note-button.

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

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

ostring default_config_file_
The config-file, which will be read and evaluated.

ostring cl_config_file_
The config-file given on the command-line.

ostring default_path_to_themes_
The default path to the directory which contains all themes.

ostring cf_path_to_themes_
The path to the themes set in the config-file.

ostring cl_path_to_themes_
The path to the themes set with the commandline-option -p.

ostring default_html_theme_
The default theme for the HTML-output.

ostring cf_html_theme_
The theme for the HTML-output set in the config-file.

ostring xml_html_theme_
The theme for the HTML-output set in the XML-file.

ostring cl_html_theme_
The theme for the HTML-output set with the commandline-option -t.

ostring full_path_to_theme_
The full path to the selected theme (path_to_themes_ + theme_).

oint default_disable_xml_settings_
1, if the settings stored in the XML-file should be disabled, else 1.

oint cf_disable_xml_settings_
The disable-xml-settings option is : 1, if set to "yes" in the config-file. 0, if set to "no" in the config-file. -1, if not given in the config-file.

oint cl_disable_xml_settings_
1, if the commandline-option -x was given, else -1.

oint default_html_resolution_
The default screen-resolution for the HTML-output.

oint cf_html_resolution_
The screen-resolution for the HTML-output set in the config-file, or -1, if the screen-resolution is not given.

oint xml_html_resolution_
The screen-resolution for the HTML-output set in the XML-file, or -1, if the screen-resolution is not given.

oint cl_html_resolution_
1, if the screen-resolution for the HTML-output was set with the commandline-option -R, else -1.

oint default_html_disable_background_graphic_
1, if the background-graphic for the slides should be disabled, else 0.

oint cl_html_disable_background_graphic_
1, if the commandline-option -B was given, else -1.

oint default_html_disable_header_graphic_
1, if the background-graphic for the header should be disabled, else 0.

oint cl_html_disable_header_graphic_
1, if the commandline_option -H was given, else -1.

oint default_html_disable_first_last_button_
1, if buttons to the first and last slide should be disabled, else 0.

oint cl_html_disable_first_last_button_
1, if the commandline-option -F was given, else -1.

oint default_html_disable_note_button_
1, if the note-button should be disabled, else 0.

oint cl_html_disable_note_button_
1, if the commandline-option -N was given, else -1.

oint default_html_sloppy_buttons_
0, if the buttons should be drawn at a fixed position. 1, if the buttons should be drawn below the content of the slide.

oint cf_html_sloppy_buttons_
The sloppy-buttons option is : 1, if set to "yes" in the config-file. 0, if set to "no" in the config-file. -1, if not given in the config-file.

oint xml_html_sloppy_buttons_
The sloppy-buttons option is : 1, if set to "yes" in the XML-file. 0, if set to "no" in the XML-file. -1, if not given in the XML-file.

oint cl_html_sloppy_buttons_
1, if the commandline-option -S was given, else -1.

oint default_html_cell_padding_
The default-value of the table-attribute 'cellpadding' used in the grid-environment.

oint xml_html_cell_padding_
The cellpadding option set in the XML-file, or -1 if not given.

oint default_html_top_navigation_
1, if all navigation-buttons should be on the top of the slide, else 0.

oint cf_html_top_navigation_
The top-navigation option is : 1, if set to "yes" in the config-file. 0, if set to "no" in the config-file. -1, if not given in the config-file.

oint xml_html_top_navigation_
The top-navigation option is : 1, if set to "yes" in the XML-file. 0, if set to "no" in the XML-file. -1, if not given in the XML-file.

oint cl_html_top_navigation_
1, if the commandline-option -T was given, else -1.

oint default_latex_print_outline_
0, if the LaTeX-output should use the documentclass 'seminar'. 1, if the documentclass 'article' should be used.

oint cf_latex_print_outline_
The print-outline option is : 1, if set to "yes" in the config-file. 0, if set to "no" in the config-file. -1, if not given in the config-file.

oint xml_latex_print_outline_
The outline option is : 1, if set to "yes" in the XML-file. 0, if set to "no" in the XML-file. -1, if not given in the XML-file.

oint cl_latex_print_outline_
1, if the commandline parameter -O was given, else -1.


This class has no child classes.

Alphabetic index Hierarchy of classes



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