The sys_config module

Dialogs and panels for managing the system configuration.

Classes

ChangeLogDialog

class src.gui.sys_config.ChangeLogDialog(parent)

A dialog for displaying the software change log.

Parameters :

parent : wxFrame

The wxFrame which should serve as the parent of this dialog.

Methods

SettingsDialog

class src.gui.sys_config.SettingsDialog(parent)

A dialog for configuring the system-wide settings.

Parameters :

parent : wxWindow

The frame or panel which spawns the dialog.

Methods

saveSettings()

Save the new settings to the configuration manager.

UserSettingsDialog

class src.gui.sys_config.UserSettingsDialog(parent)

A dialog for configuring user-specific settings.

Parameters :

parent : wxWindow

The panel or frame which spawns this dialog.

Methods

saveSettings()

Save the new user settings to the configuration manager.

UsersDialog

class src.gui.sys_config.UsersDialog(parent)

A dialog for creating and deleting users.

Parameters :

parent : wxWindow

The panel or frame which spawns this dialog.

Methods

FilesPanel

class src.gui.sys_config.FilesPanel(parent, user=False)

A panel for configuring user defaults.

This panel allows the user to set and get the settings related to where data and experiment files are saved by default, as well as whether the user wants to have scan numbers automatically included.

Parameters :

parent : wxWindow

The frame or panel which contains this panel.

user : bool

Whether this panel represents the settings of a particular user. If False, the panel will represent the global system settings.

Methods

applyData()

Set the system configuration with data from the controls.

fillData()

Fill controls with data from the system configuration.

PersonalPanel

class src.gui.sys_config.PersonalPanel(parent)

A panel for configuring a user’s personal settings.

This panel allows a certain user to control settings related to whether to send text messages on certain events automatically and to set the numbers to which such messages should be sent.

Parameters :

parent : wxWindow

The panel or frame which should be used as the parent for this panel.

Methods

applyData()

Update the system configuration with data from the controls.

fillData()

Fill the controls with data from the system configuration.

GraphsPanel

class src.gui.sys_config.GraphsPanel(*args, **kwargs)

A panel for configuring global graph settings.

In its current implementation, this panel presents a way of changing the following graphing settings:

• The list of colors used for successive plots within a graph, and
• The rate at which the graph updates (expressed as a delay time in seconds).

Methods

applyData()

Set the software configuration with the data from the controls.

fillData()

Fill the controls with data from the software configuration.

UsersPanel

class src.gui.sys_config.UsersPanel(*args, **kwargs)

This panel allows for the creation and deletion of users.

Methods

fillData()

Set the controls to reflect those from the software configuration.

Functions

src.gui.sys_config.showAboutWindow(parent)

Display an “About” dialog.

src.gui.sys_config.getHelpWindow()

Create a help window.

Load the HTML Help Workshop documentation from the doc folder and embed it in a wxPython HtmlHelpController window, and return that window.

Note

This function does not actually show the window—it just creates it. The window must be displayed by whatever calls the function.

Returns :

wxHtmlHelpController :

A window containing software documentation

src.gui.sys_config.getChangeLogDialog(parent)

Create a change log dialog.

Create and return a window displaying the change log. If the system can access the SVN server, the change log is read from that. Otherwise, it is read from a file whenever the system was last able to access the server.

Parameters :

parent : wxFrame

The wxFrame of which the returned dialog is a child. (This is useful for things like centering and making sure that this window is closed if the application is closed.)

Returns :

ChangeLogDialog :

A simple dialog containing information about all known changes to the software.