Table of Contents

Class: HappydocConfigDialog ./DocumentationTools/HappydocConfigDialog.py

Class implementing a dialog to enter the parameters for happydoc.

Base Classes   
HappydocConfigForm
Methods   
__init__
accept
generateParameters
handleCodeForeground
handleDocsetSelected
handleDocstringSyntaxSelected
handleFormatterSelected
handleIgnoreDir
handleIgnoreDirAdd
handleIgnoreDirDelete
handleL1HeadingBackground
handleL1HeadingForeground
handleL2HeadingBackground
handleL2HeadingForeground
handleOutputDir
handlePackageDescrFile
handlePageBackground
initializeDefaults
selectBgColour
selectFgColour
  __init__ 
__init__ (
        self,
        ppath,
        parms=None,
        parent=None,
        )

Constructor

Arguments

ppath
project path of the current project (string)
parms
parameters to set in the dialog
parent
parent widget of this dialog
  accept 
accept ( self )

Protected slot called by the Ok button.

It saves the values in the parameters dictionary.

  generateParameters 
generateParameters ( self )

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.

Returns

a tuple of the commandline parameters and non default parameters (QStringList, dictionary)

  handleCodeForeground 
handleCodeForeground ( self )

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.

  handleDocsetSelected 
handleDocsetSelected ( self,  id )

Private slot to handle the QButtonGroups clicked(int) signal.

It sets the selected docset type.

Arguments

id
id of the selected entry (int)
  handleDocstringSyntaxSelected 
handleDocstringSyntaxSelected ( self,  id )

Private slot to handle the QButtonGroups clicked(int) signal.

It sets the selected docstring syntax.

Arguments

id
id of the selected entry (int)
  handleFormatterSelected 
handleFormatterSelected ( self,  id )

Private slot to handle the QButtonGroups clicked(int) signal.

It sets the selected output formatter.

Arguments

id
id of the selected entry (int)
  handleIgnoreDir 
handleIgnoreDir ( self )

Private slot to select a directory to be ignored.

It displays a directory selection dialog to select a directory to be ignored.

  handleIgnoreDirAdd 
handleIgnoreDirAdd ( self )

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.

  handleIgnoreDirDelete 
handleIgnoreDirDelete ( self )

Private slot to delete the currently selected directory of the listbox.

  handleL1HeadingBackground 
handleL1HeadingBackground ( self )

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.

  handleL1HeadingForeground 
handleL1HeadingForeground ( self )

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.

  handleL2HeadingBackground 
handleL2HeadingBackground ( self )

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.

  handleL2HeadingForeground 
handleL2HeadingForeground ( self )

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.

  handleOutputDir 
handleOutputDir ( self )

Private slot to select the output directory.

It displays a directory selection dialog to select the directory the documentations is written to.

  handlePackageDescrFile 
handlePackageDescrFile ( self )

Private slot to select the package description file.

It displays a file selection dialog to select the package description file.

  handlePageBackground 
handlePageBackground ( self )

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.

  initializeDefaults 
initializeDefaults ( self )

Private method to set the default values.

These are needed later on to generate the commandline parameters.

  selectBgColour 
selectBgColour (
        self,
        textedit,
        colour,
        )

Private method used to select the background colour.

It opens a QColorDialog to select a colour and sets the background of the sample textedit.

Returns

selected colour (string)

  selectFgColour 
selectFgColour (
        self,
        textedit,
        colour,
        )

Private method used to select the foreground colour.

It opens a QColorDialog to select a colour and sets the foreground of the sample textedit.

Returns

selected colour (string)


Table of Contents

This document was automatically generated on Fri Mar 14 19:54:41 2003 by HappyDoc version 2.1