Module implementing a dialog to enter the parameters for happydoc.
HappydocConfigDialog | Class implementing a dialog to enter the parameters for happydoc. |
None |
Class implementing a dialog to enter the parameters for happydoc.
HappydocConfigDialog | Constructor |
accept | Protected slot called by the Ok button. |
generateParameters | Public method that generates the commandline parameters. |
handleCodeForeground | Private method used to select the page foreground colour. |
handleDocsetSelected | Private slot to handle the QButtonGroups clicked(int) signal. |
handleDocstringSyntaxSelected | Private slot to handle the QButtonGroups clicked(int) signal. |
handleFormatterSelected | Private slot to handle the QButtonGroups clicked(int) signal. |
handleIgnoreDir | Private slot to select a directory to be ignored. |
handleIgnoreDirAdd | Private slot to add the directory displayed to the listview. |
handleIgnoreDirDelete | Private slot to delete the currently selected directory of the listbox. |
handleL1HeadingBackground | Private method used to select the level 1 heading background colour. |
handleL1HeadingForeground | Private method used to select the level 1 heading foreground colour. |
handleL2HeadingBackground | Private method used to select the level 2 heading background colour. |
handleL2HeadingForeground | Private method used to select the level 2 heading foreground colour. |
handleOutputDir | Private slot to select the output directory. |
handlePackageDescrFile | Private slot to select the package description file. |
handlePageBackground | Private method used to select the page background colour. |
initializeDefaults | Private method to set the default values. |
selectBgColour | Private method used to select the background colour. |
selectFgColour | Private method used to select the foreground colour. |
Constructor
Protected slot called by the Ok button.
It saves the values in the parameters dictionary.
Public method that generates the commandline parameters.
It generates a QStringList to be used to set the QProcess arguments for the happydoc call and a list containing the non default parameters. The second list can be passed back upon object generation to overwrite the default settings.
Private method used to select the page foreground colour.
It opens a QColorDialog to select a colour and sets the background of the sample textedit.
Private slot to handle the QButtonGroups clicked(int) signal.
It sets the selected docset type.
Private slot to handle the QButtonGroups clicked(int) signal.
It sets the selected docstring syntax.
Private slot to handle the QButtonGroups clicked(int) signal.
It sets the selected output formatter.
Private slot to select a directory to be ignored.
It displays a directory selection dialog to select a directory to be ignored.
Private slot to add the directory displayed to the listview.
The directory in the ignore directories line edit is moved to the listbox above and the edit is cleared.
Private slot to delete the currently selected directory of the listbox.
Private method used to select the level 1 heading background colour.
It opens a QColorDialog to select a colour and sets the background of the sample textedit.
Private method used to select the level 1 heading foreground colour.
It opens a QColorDialog to select a colour and sets the background of the sample textedit.
Private method used to select the level 2 heading background colour.
It opens a QColorDialog to select a colour and sets the background of the sample textedit.
Private method used to select the level 2 heading foreground colour.
It opens a QColorDialog to select a colour and sets the background of the sample textedit.
Private slot to select the output directory.
It displays a directory selection dialog to select the directory the documentations is written to.
Private slot to select the package description file.
It displays a file selection dialog to select the package description file.
Private method used to select the page background colour.
It opens a QColorDialog to select a colour and sets the background of the sample textedit.
Private method to set the default values.
These are needed later on to generate the commandline parameters.
Private method used to select the background colour.
It opens a QColorDialog to select a colour and sets the background of the sample textedit.
Private method used to select the foreground colour.
It opens a QColorDialog to select a colour and sets the foreground of the sample textedit.