# `AppSettingsWizard`

digraph inheritance45fbdbc43a { bgcolor=transparent; rankdir=UD; ratio=compress; size="8.0, 12.0"; "AppSettingsWizard" [URL="#taurus.qt.qtgui.taurusgui.AppSettingsWizard",color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,target="_top",tooltip="This Wizard provide functionality for creating from scratch a configuration"]; "QWizard" -> "AppSettingsWizard" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QDialog" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QDialog(parent: QWidget|None = None, flags: Qt.WindowFlags|Qt.WindowType = Qt.WindowFlags())"]; "QWidget" -> "QDialog" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QObject" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QObject(parent: QObject|None = None)"]; "wrapper" -> "QObject" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QPaintDevice" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QPaintDevice()"]; "simplewrapper" -> "QPaintDevice" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QWidget" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QWidget(parent: QWidget|None = None, flags: Qt.WindowFlags|Qt.WindowType = Qt.WindowFlags())"]; "QObject" -> "QWidget" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QPaintDevice" -> "QWidget" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QWizard" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QWizard(parent: QWidget|None = None, flags: Qt.WindowFlags|Qt.WindowType = Qt.WindowFlags())"]; "QDialog" -> "QWizard" [arrowsize=0.5,style="setlinewidth(0.5)"]; "simplewrapper" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded]; "wrapper" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded]; "simplewrapper" -> "wrapper" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

class AppSettingsWizard(parent=None, jdrawCommand='jdraw', configFilePrefix='config')

  This Wizard provide functionality for creating from scratch a configuration directory for a TaurusGUI based application.

  The files in the configuration dir determine the default, permanent, pre-defined contents of the GUI. While the user may add/remove more elements at run time and those customizations will also be stored, this file defines what a user will find when launching the GUI for the first time.

  Import from `taurus.qt.qtgui.taurusgui` as:

      from taurus.qt.qtgui.taurusgui import AppSettingsWizard

  Pages = Enumeration('Pages', ['IntroPage', 'ProjectPage', 'GeneralSettings', 'CustomLogoPage', 'SynopticPage', 'MacroServerInfo', 'InstrumentsPage', 'PanelsPage', 'ExternalAppPage', 'MonitorPage', 'OutroPage'])
  SARDANA_INSTALLED = False
  addPage(self, page: QWizardPage | None) → int
  generateXml()

    returns the xml code corresponding to the options selected in the wizard and a dictionary representing the paths that have been substituted.

    Returns:

      The return value is a tuple whose first element is the xml code and the second element is a dict where the keys are the destination files and the values are the original paths.

    Return type:

      str, dict<str,str>

  static getArrayFromNode(rootNode, nodeName, default=None)

    returns an array contained by given Node

    Parameters:

      - rootNode (etree.Element) – root node

      - nodeName – the name of node to find

      - default – returned value if node is None or contains empty string

  getConfigFilePrefix()
  getPages()
  getProjectWarnings()
  static getValueFromNode(rootNode, nodeName, default=None)

    returns a value from given Node

    Parameters:

      - rootNode (etree.Element) – root node

      - nodeName – the name of node to find

      - default – returned value if node is None or contains empty string

  getXml()
  getXmlConfigFileName()
  loadXml(fname)

    parses xml code and sets all pages according to its contents. It raises an exception if something could not be processed

    Parameters:

      fname (unicode) – path to file containing xml code

  setPage(self, id: int, page: QWizardPage | None)
  substitutionName(src, mod_dir)