Public Member Functions | Public Attributes | Static Protected Attributes | Private Member Functions | Private Attributes

ConfigPanel Class Reference

The configuration panel class. More...

#include <ConfigPanel.h>

Collaboration diagram for ConfigPanel:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ConfigPanel (wxWindow *parent, DoxyBlocks *pOwner, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)
 Constructor.
virtual ~ConfigPanel ()
 Destructor.
void Init ()
 Initialise dependent control states.
wxInt8 GetBlockComment ()
void SetBlockComment (wxInt8 val)
wxInt8 GetLineComment ()
void SetLineComment (wxInt8 val)
wxString GetProjectNumber ()
void SetProjectNumber (wxString val)
wxString GetOutputDirectory ()
void SetOutputDirectory (wxString val)
wxString GetOutputLanguage ()
void SetOutputLanguage (wxString val)
bool GetUseAutoVersion ()
void SetUseAutoVersion (bool val)
bool GetExtractAll ()
void SetExtractAll (bool val)
bool GetExtractPrivate ()
void SetExtractPrivate (bool val)
bool GetExtractStatic ()
void SetExtractStatic (bool val)
bool GetWarnings ()
void SetWarnings (bool val)
bool GetWarnIfDocError ()
void SetWarnIfDocError (bool val)
bool GetWarnIfUndocumented ()
void SetWarnIfUndocumented (bool val)
bool GetWarnNoParamdoc ()
void SetWarnNoParamdoc (bool val)
bool GetAlphabeticalIndex ()
void SetAlphabeticalIndex (bool val)
bool GetGenerateHTML ()
void SetGenerateHTML (bool val)
bool GetGenerateHTMLHelp ()
void SetGenerateHTMLHelp (bool val)
bool GetGenerateCHI ()
void SetGenerateCHI (bool val)
bool GetBinaryTOC ()
void SetBinaryTOC (bool val)
bool GetGenerateLatex ()
void SetGenerateLatex (bool val)
bool GetGenerateRTF ()
void SetGenerateRTF (bool val)
bool GetGenerateMan ()
void SetGenerateMan (bool val)
bool GetGenerateXML ()
void SetGenerateXML (bool val)
bool GetGenerateAutogenDef ()
void SetGenerateAutogenDef (bool val)
bool GetGeneratePerlMod ()
void SetGeneratePerlMod (bool val)
bool GetEnablePreprocessing ()
void SetEnablePreprocessing (bool val)
bool GetHaveDot ()
void SetHaveDot (bool val)
bool GetClassDiagrams ()
void SetClassDiagrams (bool val)
wxString GetPathDoxygen ()
void SetPathDoxygen (wxString val)
wxString GetPathDoxywizard ()
void SetPathDoxywizard (wxString val)
wxString GetPathHHC ()
void SetPathHHC (wxString val)
wxString GetPathDot ()
void SetPathDot (wxString val)
wxString GetPathCHMViewer ()
void SetPathCHMViewer (wxString val)
bool GetOverwriteDoxyfile ()
void SetOverwriteDoxyfile (bool val)
bool GetPromptBeforeOverwriting ()
void SetPromptBeforeOverwriting (bool val)
bool GetUseAtInTags ()
void SetUseAtInTags (bool val)
bool GetLoadTemplate ()
void SetLoadTemplate (bool val)
bool GetUseInternalViewer ()
void SetUseInternalViewer (bool val)
bool GetRunHTML ()
void SetRunHTML (bool val)
bool GetRunCHM ()
void SetRunCHM (bool val)
void SetAutoVersioning (bool val)

Public Attributes

cbStyledTextCtrl * TextCtrlBlockComment
 A pointer to a cbStyledTextCtrl containing the sample block comment.
wxCheckBox * CheckBoxGenerateHTML
 A pointer to the Generate HTML wxCheckBox.
wxButton * ButtonBrowseHHC
 A pointer to the HHC Browse wxButton.
wxCheckBox * CheckBoxGenerateLatex
 A pointer to the Generate Latex wxCheckBox.
wxCheckBox * CheckBoxOverwriteDoxyfile
 A pointer to the Overwrite Doxyfile wxCheckBox.
wxButton * ButtonBrowseCHMViewer
 A pointer to the CHM viewer Browse wxButton.
wxCheckBox * CheckBoxClassDiagrams
 A pointer to the Class Diagrams wxCheckBox.
wxTextCtrl * TextCtrlOutputDirectory
 A pointer to the Output Directory wxTextCtrl.
wxButton * ButtonBrowseDoxywizard
 A pointer to the Doxywizard Browse wxButton.
wxCheckBox * CheckBoxGenerateHTMLHelp
 A pointer to the Generate HTML Help wxCheckBox.
wxTextCtrl * TextCtrlPathHHC
 A pointer to the HHC Path wxTextCtrl.
wxRadioBox * RadioBoxBlockComments
 A pointer to the Block Comment types wxRadioBox.
wxChoice * ChoiceOutputLanguage
 A pointer to a wxChoice control listing the language options.
wxCheckBox * CheckBoxRunHTML
 A pointer to the Run HTML wxCheckBox.
wxTextCtrl * TextCtrlPathDot
 A pointer to the Dot Path wxTextCtrl.
wxCheckBox * CheckBoxUseInternalViewer
 A pointer to the Use Internal Viewer wxCheckBox.
wxCheckBox * CheckBoxGenerateCHI
 A pointer to the Generate CHI wxCheckBox.
wxCheckBox * CheckBoxGenerateRTF
 A pointer to the Generate RTF wxCheckBox.
wxCheckBox * CheckBoxWarnIfUndocumented
 A pointer to the Warn If Undocumented wxCheckBox.
wxCheckBox * CheckBoxGenerateAutogenDef
 A pointer to the Generate Autogen Def wxCheckBox.
wxCheckBox * CheckBoxExtractAll
 A pointer to Extract All wxCheckBox.
wxButton * ButtonBrowseDot
 A pointer to the Dot Browse wxButton.
wxTextCtrl * TextCtrlPathDoxygen
 A pointer to the Doxygen Path wxTextCtrl.
wxCheckBox * CheckBoxWarnings
 A pointer to the Warnings wxCheckBox.
wxTextCtrl * TextCtrlProjectNumber
 A pointer to the Project Number wxTextCtrl.
wxTextCtrl * TextCtrlPathDoxywizard
 A pointer to the Doxywizard Path wxTextCtrl.
wxCheckBox * CheckBoxAlphabeticalIndex
 A pointer to the Alphabetical Index wxCheckBox.
wxCheckBox * CheckBoxRunCHM
 A pointer to the Run CHM wxCheckBox.
wxCheckBox * CheckBoxWarnIfDocError
 A pointer to the Warn If Doc Error wxCheckBox.
wxCheckBox * CheckBoxGeneratePerlMod
 A pointer to the Generate PerlMod wxCheckBox.
wxButton * ButtonBrowseDoxygen
 A pointer to the Doxygen Browse wxButton.
wxCheckBox * CheckBoxGenerateXML
 A pointer to the Generate XML wxCheckBox.
wxCheckBox * CheckBoxUseAtInTags
 A pointer to the Use At In Tags wxCheckBox.
wxCheckBox * CheckBoxHaveDot
 A pointer to the Have Dot wxCheckBox.
wxCheckBox * CheckBoxExtractStatic
 A pointer to the Extract Static wxCheckBox.
cbStyledTextCtrl * TextCtrlLineComment
 A pointer to a cbStyledTextCtrl containing the sample line comment.
wxCheckBox * CheckBoxWarnNoParamdoc
 A pointer to the Warn No Paramdoc wxCheckBox.
wxCheckBox * CheckBoxBinaryTOC
 A pointer to the Binary TOC wxCheckBox.
wxRadioBox * RadioBoxLineComments
 A pointer to the Line Comment types wxRadioBox.
wxCheckBox * CheckBoxGenerateMan
 A pointer to the Generate Man wxCheckBox.
wxCheckBox * CheckBoxUseAutoVersion
 A pointer to the Use Auto Version wxCheckBox.
wxCheckBox * CheckBoxEnablePreprocessing
 A pointer to the Enable Preprocessing wxCheckBox.
wxTextCtrl * TextCtrlPathCHMViewer
 A pointer to the CHM Viewer Path wxTextCtrl.
wxCheckBox * CheckBoxExtractPrivate
 A pointer to the Extract Private wxCheckBox.
wxCheckBox * CheckBoxLoadTemplate
 A pointer to the Load Template wxCheckBox.
wxCheckBox * CheckBoxPromptBeforeOverwriting
 A pointer to the Prompt Before Overwriting wxCheckBox.

Static Protected Attributes

static const long ID_RADIOBOX_BLOCKCOMMENTS = wxNewId()
 Control ID.
static const long ID_TEXTCTRL_BLOCKCOMMENT = wxNewId()
 Control ID.
static const long ID_RADIOBOX_LINECOMMENTS = wxNewId()
 Control ID.
static const long ID_TEXTCTRL_LINECOMMENT = wxNewId()
 Control ID.
static const long ID_PANEL2 = wxNewId()
 Control ID.
static const long ID_STATICTEXT1 = wxNewId()
 Control ID.
static const long ID_TEXTCTRL_PROJECTNUMBER = wxNewId()
 Control ID.
static const long ID_CHECKBOX_USEAUTOVERSION = wxNewId()
 Control ID.
static const long ID_STATICTEXT8 = wxNewId()
 Control ID.
static const long ID_TEXTCTRLOUTPUT_DIRECTORY = wxNewId()
 Control ID.
static const long ID_STATICTEXT5 = wxNewId()
 Control ID.
static const long ID_CHOICE_OUTPUT_LANGUAGE = wxNewId()
 Control ID.
static const long ID_CHECKBOX_EXTRACT_ALL = wxNewId()
 Control ID.
static const long ID_CHECKBOX_EXTRACTPRIVATE = wxNewId()
 Control ID.
static const long ID_CHECKBOX_EXTRACTSTATIC = wxNewId()
 Control ID.
static const long ID_CHECKBOX_WARNINGS = wxNewId()
 Control ID.
static const long ID_CHECKBOX_WARN_IF_DOC_ERROR = wxNewId()
 Control ID.
static const long ID_CHECKBOX_WARN_IF_UNDOCUMENTED = wxNewId()
 Control ID.
static const long ID_CHECKBOX_WARN_NO_PARAMDOC = wxNewId()
 Control ID.
static const long ID_CHECKBOX_ALPHABETICAL_INDEX = wxNewId()
 Control ID.
static const long ID_PANEL3 = wxNewId()
 Control ID.
static const long ID_CHECKBOX_GENERATE_HTML = wxNewId()
 Control ID.
static const long ID_CHECKBOX_GENERATE_HTMLHELP = wxNewId()
 Control ID.
static const long ID_CHECKBOX_GENERATE_CHI = wxNewId()
 Control ID.
static const long ID_CHECKBOX_BINARY_TOC = wxNewId()
 Control ID.
static const long ID_CHECKBOX_GENERATE_LATEX = wxNewId()
 Control ID.
static const long ID_CHECKBOX_GENERATE_RTF = wxNewId()
 Control ID.
static const long ID_CHECKBOX_GENERATE_MAN = wxNewId()
 Control ID.
static const long ID_CHECKBOX_GENERATE_XML = wxNewId()
 Control ID.
static const long ID_CHECKBOX_GENERATE_AUTOGEN_DEF = wxNewId()
 Control ID.
static const long ID_CHECKBOX_GENERATE_PERLMOD = wxNewId()
 Control ID.
static const long ID_CHECKBOX_ENABLE_PREPROCESSING = wxNewId()
 Control ID.
static const long ID_CHECKBOX_CLASS_DIAGRAMS = wxNewId()
 Control ID.
static const long ID_CHECKBOX_HAVE_DOT = wxNewId()
 Control ID.
static const long ID_PANEL4 = wxNewId()
 Control ID.
static const long ID_STATICTEXT2 = wxNewId()
 Control ID.
static const long ID_TEXTCTRL_PATHDOXYGEN = wxNewId()
 Control ID.
static const long ID_BUTTON_BROWSEDOXYGEN = wxNewId()
 Control ID.
static const long ID_STATICTEXT4 = wxNewId()
 Control ID.
static const long ID_TEXTCTRL_PATHDOXYWIZARD = wxNewId()
 Control ID.
static const long ID_BUTTON_BROWSEDOXYWIZARD = wxNewId()
 Control ID.
static const long ID_STATICTEXT3 = wxNewId()
 Control ID.
static const long ID_TEXTCTRL_PATHHHC = wxNewId()
 Control ID.
static const long ID_BUTTON_BROWSEHHC = wxNewId()
 Control ID.
static const long ID_STATICTEXT6 = wxNewId()
 Control ID.
static const long ID_TEXTCTRL_PATHDOT = wxNewId()
 Control ID.
static const long ID_BUTTON_BROWSEDOT = wxNewId()
 Control ID.
static const long ID_STATICTEXT7 = wxNewId()
 Control ID.
static const long ID_TEXTCTRL_PATHCHMVIEWER = wxNewId()
 Control ID.
static const long ID_BUTTON_BROWSECHMVIEWER = wxNewId()
 Control ID.
static const long ID_CHECKBOX_OVERWRITEDOXYFILE = wxNewId()
 Control ID.
static const long ID_CHECKBOX_PROMPTB4OVERWRITING = wxNewId()
 Control ID.
static const long ID_CHECKBOX_USEATINTAGS = wxNewId()
 Control ID.
static const long ID_CHECKBOX_LOADTEMPLATE = wxNewId()
 Control ID.
static const long ID_CHECKBOX_USEINTERNALVIEWER = wxNewId()
 Control ID.
static const long ID_CHECKBOX_RUNHTML = wxNewId()
 Control ID.
static const long ID_CHECKBOX_RUNCHM = wxNewId()
 Control ID.
static const long ID_PANEL1 = wxNewId()
 Control ID.
static const long ID_NOTEBOOK_PREFS = wxNewId()
 Control ID.

Private Member Functions

void OnRadioBoxBlockCommentsSelect (wxCommandEvent &event)
 A block comment radio button was selected.
void OnRadioBoxLineCommentsSelect (wxCommandEvent &event)
 A line comment radio button was selected.
void OnButtonBrowseDoxygenClick (wxCommandEvent &event)
 The doxygen path browse button was clicked.
void OnButtonBrowseDoxywizardClick (wxCommandEvent &event)
 The doxywizard path browse button was clicked.
void OnButtonBrowseHHCClick (wxCommandEvent &event)
 The HHC path browse button was clicked.
void OnButtonBrowseDotClick (wxCommandEvent &event)
 The Dot path browse button was clicked.
void OnCheckBoxGenerateHTMLClick (wxCommandEvent &event)
 The Generate HTML check box was clicked. Enable or disable dependent checkboxes.
void OnCheckBoxOverwriteDoxyfileClick (wxCommandEvent &event)
 The Overwrite Doxyfile check box was clicked. Enable or disable dependent checkboxes.
void OnCheckBoxWarningsClick (wxCommandEvent &event)
 The Warnings check box was clicked. Enable or disable dependent checkboxes.
void OnCheckBoxUseAutoversionClick (wxCommandEvent &event)
 The "Use AutoVersion" checkbox was clicked. Update the "Project Number" text control.
void OnCheckBoxUseAtInTagsClick (wxCommandEvent &event)
 The "Use @ In Tags" checkbox was clicked. Refresh the block comment sample with the new tag.
void OnButtonBrowseCHMViewerClick (wxCommandEvent &event)
 The CHM Viewer path browse button was clicked.
wxString GetTitle () const
 Get the title to show in the settings image list and in the panel header.
wxString GetBitmapBaseName () const
 Get the base name for the images to be displayed in the settings image list.
void OnApply ()
 Apply configuration changes.
void OnCancel ()
 Cancel configuration changes.
wxString GetApplicationPath ()
 Display a file dialogue and return the selected path.
void InitSTC (cbStyledTextCtrl *stc)
 Initialise a wxStyledTextControl.
void WriteBlockComment (cbStyledTextCtrl *stc, int iBlockComment, bool bUseAtInTags)
 Write the block comment sample, based on the radio box selection.
void WriteLineComment (cbStyledTextCtrl *stc, int iLineComment)
 Write the line comment sample, based on the radio box selection.

Private Attributes

DoxyBlocksm_pOwnerClass
 The class that owns this dialogue. Used for calling OnDialogueDone().
bool m_bAutoVersioning
 Whether AutoVersioning is active for the current project.
bool m_bUseAutoVersion
 Whether to to use the AutoVersion-generated version string.

Detailed Description

The configuration panel class.


Member Function Documentation

bool ConfigPanel::GetAlphabeticalIndex (  )  [inline]

Access CheckBoxAlphabeticalIndex

Returns:
The current value of CheckBoxAlphabeticalIndex
wxString ConfigPanel::GetApplicationPath (  )  [private]

Display a file dialogue and return the selected path.

Returns:
wxString The application path.
bool ConfigPanel::GetBinaryTOC (  )  [inline]

Access CheckBoxBinaryTOC

Returns:
The current value of CheckBoxBinaryTOC
wxString ConfigPanel::GetBitmapBaseName (  )  const [private]

Get the base name for the images to be displayed in the settings image list.

Returns:
wxString The bitmap base name.

Virtual routine required by cbConfigurationPanel

wxInt8 ConfigPanel::GetBlockComment (  )  [inline]

Access RadioBoxBlockComments

Returns:
The current value of RadioBoxBlockComments
bool ConfigPanel::GetClassDiagrams (  )  [inline]

Access CheckBoxClassDiagrams

Returns:
The current value of CheckBoxClassDiagrams
bool ConfigPanel::GetEnablePreprocessing (  )  [inline]

Access CheckBoxEnablePreprocessing

Returns:
The current value of CheckBoxEnablePreprocessing
bool ConfigPanel::GetExtractAll (  )  [inline]

Access CheckBoxExtractAll

Returns:
The current value of CheckBoxExtractAll
bool ConfigPanel::GetExtractPrivate (  )  [inline]

Access CheckBoxExtractPrivate

Returns:
The current value of CheckBoxExtractPrivate
bool ConfigPanel::GetExtractStatic (  )  [inline]

Access CheckBoxExtractStatic

Returns:
The current value of CheckBoxExtractStatic
bool ConfigPanel::GetGenerateAutogenDef (  )  [inline]

Access CheckBoxGenerateAutogenDef

Returns:
The current value of CheckBoxGenerateAutogenDef
bool ConfigPanel::GetGenerateCHI (  )  [inline]

Access CheckBoxGenerateCHI

Returns:
The current value of CheckBoxGenerateCHI
bool ConfigPanel::GetGenerateHTML (  )  [inline]

Access CheckBoxGenerateHTML

Returns:
The current value of CheckBoxGenerateHTML
bool ConfigPanel::GetGenerateHTMLHelp (  )  [inline]

Access CheckBoxGenerateHTMLHelp

Returns:
The current value of CheckBoxGenerateHTMLHelp
bool ConfigPanel::GetGenerateLatex (  )  [inline]

Access CheckBoxGenerateLatex;

Returns:
The current value of CheckBoxGenerateLatex;
bool ConfigPanel::GetGenerateMan (  )  [inline]

Access CheckBoxGenerateMan

Returns:
The current value of CheckBoxGenerateMan
bool ConfigPanel::GetGeneratePerlMod (  )  [inline]

Access CheckBoxGeneratePerlMod

Returns:
The current value of CheckBoxGeneratePerlMod
bool ConfigPanel::GetGenerateRTF (  )  [inline]

Access CheckBoxGenerateRTF

Returns:
The current value of CheckBoxGenerateRTF
bool ConfigPanel::GetGenerateXML (  )  [inline]

Access CheckBoxGenerateXML

Returns:
The current value of CheckBoxGenerateXML
bool ConfigPanel::GetHaveDot (  )  [inline]

Access CheckBoxHaveDot

Returns:
The current value of CheckBoxHaveDot
wxInt8 ConfigPanel::GetLineComment (  )  [inline]

Access RadioBoxLineComments

Returns:
The current value of RadioBoxLineComments
bool ConfigPanel::GetLoadTemplate (  )  [inline]

Access CheckBoxLoadTemplate

Returns:
The current value of CheckBoxLoadTemplate
wxString ConfigPanel::GetOutputDirectory (  )  [inline]

Access TextCtrlOutputDirectory

Returns:
The current value of TextCtrlOutputDirectory
wxString ConfigPanel::GetOutputLanguage (  )  [inline]

Access ChoiceOutputLanguage

Returns:
The current value of ChoiceOutputLanguage
bool ConfigPanel::GetOverwriteDoxyfile (  )  [inline]

Access CheckBoxOverwriteDoxyfile

Returns:
The current value of CheckBoxOverwriteDoxyfile
wxString ConfigPanel::GetPathCHMViewer (  )  [inline]

Access TextCtrlPathCHMViewer

Returns:
The current value of TextCtrlPathCHMViewer
wxString ConfigPanel::GetPathDot (  )  [inline]

Access TextCtrlPathDot

Returns:
The current value of TextCtrlPathDot
wxString ConfigPanel::GetPathDoxygen (  )  [inline]

Access TextCtrlPathDoxygen

Returns:
The current value of TextCtrlPathDoxygen
wxString ConfigPanel::GetPathDoxywizard (  )  [inline]

Access TextCtrlPathDoxywizard

Returns:
The current value of TextCtrlPathDoxywizard
wxString ConfigPanel::GetPathHHC (  )  [inline]

Access TextCtrlPathHHC

Returns:
The current value of TextCtrlPathHHC
wxString ConfigPanel::GetProjectNumber (  )  [inline]

Access TextCtrlProjectNumber

Returns:
The current value of TextCtrlProjectNumber
bool ConfigPanel::GetPromptBeforeOverwriting (  )  [inline]

Access CheckBoxPromptBeforeOverwriting

Returns:
The current value of CheckBoxPromptBeforeOverwriting
bool ConfigPanel::GetRunCHM (  )  [inline]

Access CheckBoxRunCHM

Returns:
The current value of CheckBoxRunCHM
bool ConfigPanel::GetRunHTML (  )  [inline]

Access CheckBoxRunHTML

Returns:
The current value of CheckBoxRunHTML
wxString ConfigPanel::GetTitle (  )  const [inline, private]

Get the title to show in the settings image list and in the panel header.

Returns:
wxString

Virtual routine required by cbConfigurationPanel

bool ConfigPanel::GetUseAtInTags (  )  [inline]

Access CheckBoxUseAtInTags

Returns:
The current value of CheckBoxUseAtInTags
bool ConfigPanel::GetUseAutoVersion (  )  [inline]

Access CheckBoxUseAutoVersion

Returns:
The current value of CheckBoxUseAutoVersion
bool ConfigPanel::GetUseInternalViewer (  )  [inline]

Access CheckBoxUseInternalViewer

Returns:
The current value of CheckBoxUseInternalViewer
bool ConfigPanel::GetWarnIfDocError (  )  [inline]

Access CheckBoxWarnIfDocError

Returns:
The current value of CheckBoxWarnIfDocError
bool ConfigPanel::GetWarnIfUndocumented (  )  [inline]

Access CheckBoxWarnIfUndocumented

Returns:
The current value of CheckBoxWarnIfUndocumented
bool ConfigPanel::GetWarnings (  )  [inline]

Access CheckBoxWarnings

Returns:
The current value of CheckBoxWarnings
bool ConfigPanel::GetWarnNoParamdoc (  )  [inline]

Access CheckBoxWarnNoParamdoc

Returns:
The current value of CheckBoxWarnNoParamdoc
void ConfigPanel::Init (  ) 

Initialise dependent control states.

Returns:
void

This function must be called after the setters have been called so that initial states are set first.

Here is the call graph for this function:

void ConfigPanel::InitSTC ( cbStyledTextCtrl *  stc  )  [private]

Initialise a wxStyledTextControl.

Parameters:
stc cbStyledTextCtrl* The text editor control.

This function initialises the styled text controls used for the comment samples. It sets the lexer, margin, font and other parameters and colourises the text.

void ConfigPanel::OnApply (  )  [private]

Apply configuration changes.

Virtual routine required by cbConfigurationPanel

Here is the call graph for this function:

void ConfigPanel::OnButtonBrowseCHMViewerClick ( wxCommandEvent &  event  )  [private]

The CHM Viewer path browse button was clicked.

Parameters:
event wxCommandEvent& A wxCommandEvent object.

Here is the call graph for this function:

void ConfigPanel::OnButtonBrowseDotClick ( wxCommandEvent &  event  )  [private]

The Dot path browse button was clicked.

Parameters:
event wxCommandEvent& A wxCommandEvent object.

Here is the call graph for this function:

void ConfigPanel::OnButtonBrowseDoxygenClick ( wxCommandEvent &  event  )  [private]

The doxygen path browse button was clicked.

Parameters:
event A wxCommandEvent reference.

Here is the call graph for this function:

void ConfigPanel::OnButtonBrowseDoxywizardClick ( wxCommandEvent &  event  )  [private]

The doxywizard path browse button was clicked.

Parameters:
event wxCommandEvent& A wxCommandEvent object.

Here is the call graph for this function:

void ConfigPanel::OnButtonBrowseHHCClick ( wxCommandEvent &  event  )  [private]

The HHC path browse button was clicked.

Parameters:
event wxCommandEvent& A wxCommandEvent object.

Here is the call graph for this function:

void ConfigPanel::OnCancel (  )  [inline, private]

Cancel configuration changes.

Virtual routine required by cbConfigurationPanel

void ConfigPanel::OnCheckBoxGenerateHTMLClick ( wxCommandEvent &  event  )  [private]

The Generate HTML check box was clicked. Enable or disable dependent checkboxes.

Parameters:
event wxCommandEvent& A wxCommandEvent object.
void ConfigPanel::OnCheckBoxOverwriteDoxyfileClick ( wxCommandEvent &  event  )  [private]

The Overwrite Doxyfile check box was clicked. Enable or disable dependent checkboxes.

Parameters:
event wxCommandEvent& A wxCommandEvent object.
void ConfigPanel::OnCheckBoxUseAtInTagsClick ( wxCommandEvent &  event  )  [private]

The "Use @ In Tags" checkbox was clicked. Refresh the block comment sample with the new tag.

Parameters:
event wxCommandEvent& A wxCommandEvent object.
Returns:
void

Here is the call graph for this function:

void ConfigPanel::OnCheckBoxUseAutoversionClick ( wxCommandEvent &  event  )  [private]

The "Use AutoVersion" checkbox was clicked. Update the "Project Number" text control.

Parameters:
event wxCommandEvent& A wxCommandEvent object.
Returns:
void

This function disables the "Project Number" text control if "Use AutoVersion" is selected. This prevents manual entry but allows the detected version number to still be visible.

void ConfigPanel::OnCheckBoxWarningsClick ( wxCommandEvent &  event  )  [private]

The Warnings check box was clicked. Enable or disable dependent checkboxes.

Parameters:
event wxCommandEvent& A wxCommandEvent object.
void ConfigPanel::OnRadioBoxBlockCommentsSelect ( wxCommandEvent &  event  )  [private]

A block comment radio button was selected.

Parameters:
event wxCommandEvent& A wxCommandEvent object.

Here is the call graph for this function:

void ConfigPanel::OnRadioBoxLineCommentsSelect ( wxCommandEvent &  event  )  [private]

A line comment radio button was selected.

Parameters:
event wxCommandEvent& A wxCommandEvent object.

Here is the call graph for this function:

void ConfigPanel::SetAlphabeticalIndex ( bool  val  )  [inline]

Set CheckBoxAlphabeticalIndex

Parameters:
val New value to set
void ConfigPanel::SetAutoVersioning ( bool  val  )  [inline]

Set m_bAutoVersioning

Parameters:
val New value to set
void ConfigPanel::SetBinaryTOC ( bool  val  )  [inline]

Set CheckBoxBinaryTOC

Parameters:
val New value to set
void ConfigPanel::SetBlockComment ( wxInt8  val  )  [inline]

Set RadioBoxBlockComments

Parameters:
val New value to set
void ConfigPanel::SetClassDiagrams ( bool  val  )  [inline]

Set CheckBoxClassDiagrams

Parameters:
val New value to set
void ConfigPanel::SetEnablePreprocessing ( bool  val  )  [inline]

Set CheckBoxEnablePreprocessing

Parameters:
val New value to set
void ConfigPanel::SetExtractAll ( bool  val  )  [inline]

Set CheckBoxExtractAll

Parameters:
val New value to set
void ConfigPanel::SetExtractPrivate ( bool  val  )  [inline]

Set CheckBoxExtractPrivate

Parameters:
val New value to set
void ConfigPanel::SetExtractStatic ( bool  val  )  [inline]

Set CheckBoxExtractStatic

Parameters:
val New value to set
void ConfigPanel::SetGenerateAutogenDef ( bool  val  )  [inline]

Set CheckBoxGenerateAutogenDef

Parameters:
val New value to set
void ConfigPanel::SetGenerateCHI ( bool  val  )  [inline]

Set CheckBoxGenerateCHI

Parameters:
val New value to set
void ConfigPanel::SetGenerateHTML ( bool  val  )  [inline]

Set CheckBoxGenerateHTML

Parameters:
val New value to set
void ConfigPanel::SetGenerateHTMLHelp ( bool  val  )  [inline]

Set CheckBoxGenerateHTMLHelp

Parameters:
val New value to set
void ConfigPanel::SetGenerateLatex ( bool  val  )  [inline]

Set CheckBoxGenerateLatex;

Parameters:
val New value to set
void ConfigPanel::SetGenerateMan ( bool  val  )  [inline]

Set CheckBoxGenerateMan

Parameters:
val New value to set
void ConfigPanel::SetGeneratePerlMod ( bool  val  )  [inline]

Set CheckBoxGeneratePerlMod

Parameters:
val New value to set
void ConfigPanel::SetGenerateRTF ( bool  val  )  [inline]

Set CheckBoxGenerateRTF

Parameters:
val New value to set
void ConfigPanel::SetGenerateXML ( bool  val  )  [inline]

Set CheckBoxGenerateXML

Parameters:
val New value to set
void ConfigPanel::SetHaveDot ( bool  val  )  [inline]

Set CheckBoxHaveDot

Parameters:
val New value to set
void ConfigPanel::SetLineComment ( wxInt8  val  )  [inline]

Set RadioBoxLineComments

Parameters:
val New value to set
void ConfigPanel::SetLoadTemplate ( bool  val  )  [inline]

Set CheckBoxLoadTemplate

Parameters:
val New value to set
void ConfigPanel::SetOutputDirectory ( wxString  val  )  [inline]

Set TextCtrlOutputDirectory

Parameters:
val New value to set
void ConfigPanel::SetOutputLanguage ( wxString  val  )  [inline]

Set ChoiceOutputLanguage

Parameters:
val New value to set
void ConfigPanel::SetOverwriteDoxyfile ( bool  val  )  [inline]

Set CheckBoxOverwriteDoxyfile

Parameters:
val New value to set
void ConfigPanel::SetPathCHMViewer ( wxString  val  )  [inline]

Set TextCtrlPathCHMViewer

Parameters:
val New value to set
void ConfigPanel::SetPathDot ( wxString  val  )  [inline]

Set TextCtrlPathDot

Parameters:
val New value to set
void ConfigPanel::SetPathDoxygen ( wxString  val  )  [inline]

Set TextCtrlPathDoxygen

Parameters:
val New value to set
void ConfigPanel::SetPathDoxywizard ( wxString  val  )  [inline]

Set TextCtrlPathDoxywizard

Parameters:
val New value to set
void ConfigPanel::SetPathHHC ( wxString  val  )  [inline]

Set TextCtrlPathHHC

Parameters:
val New value to set
void ConfigPanel::SetProjectNumber ( wxString  val  )  [inline]

Set TextCtrlProjectNumber

Parameters:
val New value to set
void ConfigPanel::SetPromptBeforeOverwriting ( bool  val  )  [inline]

Set CheckBoxPromptBeforeOverwriting

Parameters:
val New value to set
void ConfigPanel::SetRunCHM ( bool  val  )  [inline]

Set CheckBoxRunCHM

Parameters:
val New value to set
void ConfigPanel::SetRunHTML ( bool  val  )  [inline]

Set CheckBoxRunHTML

Parameters:
val New value to set
void ConfigPanel::SetUseAtInTags ( bool  val  )  [inline]

Set CheckBoxUseAtInTags

Parameters:
val New value to set
void ConfigPanel::SetUseAutoVersion ( bool  val  )  [inline]

Set CheckBoxUseAutoVersion

Parameters:
val New value to set
void ConfigPanel::SetUseInternalViewer ( bool  val  )  [inline]

Set CheckBoxUseInternalViewer

Parameters:
val New value to set
void ConfigPanel::SetWarnIfDocError ( bool  val  )  [inline]

Set CheckBoxWarnIfDocError

Parameters:
val New value to set
void ConfigPanel::SetWarnIfUndocumented ( bool  val  )  [inline]

Set CheckBoxWarnIfUndocumented

Parameters:
val New value to set
void ConfigPanel::SetWarnings ( bool  val  )  [inline]

Set CheckBoxWarnings

Parameters:
val New value to set
void ConfigPanel::SetWarnNoParamdoc ( bool  val  )  [inline]

Set CheckBoxWarnNoParamdoc

Parameters:
val New value to set
void ConfigPanel::WriteBlockComment ( cbStyledTextCtrl *  stc,
int  iBlockComment,
bool  bUseAtInTags 
) [private]

Write the block comment sample, based on the radio box selection.

Parameters:
stc cbStyledTextCtrl* The text editor control.
iBlockComment int The comment style.
bUseAtInTags bool Whether or not to use "@" in tags rather than "\".
void ConfigPanel::WriteLineComment ( cbStyledTextCtrl *  stc,
int  iLineComment 
) [private]

Write the line comment sample, based on the radio box selection.

Parameters:
stc cbStyledTextCtrl* The text editor control.
iLineComment int The comment style.

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