Trees       Indices       Help   
relax
Package gui :: Module relax_gui :: Class Main
[hide private]
[frames] | no frames]

Class Main

source code

The main GUI class.

Instance Methods [hide private]
EvtHandler
__init__(self, parent=None, id=-1, title='')
Initialise the main relax GUI frame.		 source code
 
about_relax(self, event=None)
The about message for relax.		 source code
 
action_export_bmrb(self, event=None)
Export the contents of the current data pipe for BMRB deposition.		 source code
 
action_state_save(self, event=None)
Save the program state.		 source code
 
action_state_save_as(self, event=None)
Save the program state with file name selection.		 source code
 
add_start_screen(self)
Create a start screen for the main window when no analyses exist.		 source code
 
build_toolbar(self)
Create the toolbar.		 source code
 
close_windows(self)
Throw a warning to close all of the non-essential windows when execution is locked.		 source code
 
contact_relax(self, event=None)
Write an email to the relax mailing-list using the standard mailing program.		 source code
 
enable(self)
Enable and disable certain parts of the main window with the execution lock.		 source code
 
exit_gui(self, event=None)
Catch the main window closure and perform the exit procedure.		 source code
 
init_data(self)
Initialise the data used by the GUI interface.		 source code
 
free_file_format_settings(self, event=None)
Open the free file format settings window.		 source code
 
references(self, event=None)
Display the references relevant for relax.		 source code
 
relax_manual(self, event=None)
Display the relax manual.		 source code
 
reset(self)
Reset the GUI.		 source code
 
run_test_suite(self, event=None, categories=['system', 'unit', 'gui', 'verification'])
Execute the full test suite.		 source code
 
run_test_suite_gui(self, event=None)
Execute the GUI tests.		 source code
 
run_test_suite_sys(self, event=None)
Execute the system tests.		 source code
 
run_test_suite_unit(self, event=None)
Execute the unit tests.		 source code
 
run_test_suite_verification(self, event=None)
Execute the verification tests.		 source code
 
show_controller(self, event=None)
Display the relax controller window.		 source code
 
show_pipe_editor(self, event=None)
Display the data pipe editor window.		 source code
 
show_prompt(self, event=None)
Display the relax prompt window.		 source code
 
show_results_viewer(self, event=None)
Display the analysis results.		 source code
 
show_results_viewer_safe(self, warn=False)
Display the analysis results in a thread safe wx.CallAfter call.		 source code
 
show_results_viewer_no_warn(self)
Display the analysis results.		 source code
 
show_tree(self, event=None)
Display the molecule, residue, and spin tree window.		 source code
 
state_load(self, event=None, file_name=None)
Load the program state.		 source code
 
state_save(self)
Save the program state.		 source code
 
sync_ds(self, upload=False)
Synchronise the GUI and the relax data store, both ways.		 source code
 
uf_call(self, event=None)
Catch the user function call to properly specify the parent window.		 source code
 
update_status_bar(self)
Update the status bar info.		 source code

Inherited from wx._windows.Frame: Create, CreateStatusBar, CreateToolBar, DoGiveHelp, DoMenuUpdates, FindItemInMenuBar, GetMenuBar, GetStatusBar, GetStatusBarPane, GetToolBar, PopStatusText, ProcessCommand, PushStatusText, SetMenuBar, SetStatusBar, SetStatusBarPane, SetStatusText, SetStatusWidths, SetToolBar

Inherited from wx._windows.TopLevelWindow: CenterOnScreen, CentreOnScreen, EnableCloseButton, GetDefaultItem, GetIcon, GetTitle, GetTmpDefaultItem, Iconize, IsActive, IsAlwaysMaximized, IsFullScreen, IsIconized, IsMaximized, MacGetMetalAppearance, MacGetTopLevelWindowRef, MacGetUnifiedAppearance, MacSetMetalAppearance, Maximize, OSXIsModified, OSXSetModified, RequestUserAttention, Restore, SetDefaultItem, SetIcon, SetIcons, SetRepresentedFilename, SetShape, SetTitle, SetTmpDefaultItem, ShowFullScreen, ShowWithoutActivating, __repr__

Inherited from wx._core.Window: AcceptsFocus, AcceptsFocusFromKeyboard, AddChild, AdjustForLayoutDirection, AlwaysShowScrollbars, AssociateHandle, CacheBestSize, CanAcceptFocus, CanAcceptFocusFromKeyboard, CanApplyThemeBorder, CanBeOutsideClientArea, CanScroll, CanSetTransparent, CaptureMouse, Center, CenterOnParent, Centre, CentreOnParent, ClearBackground, ClientToScreen, ClientToScreenXY, ClientToWindowSize, Close, ConvertDialogPointToPixels, ConvertDialogSizeToPixels, ConvertPixelPointToDialog, ConvertPixelSizeToDialog, DLG_PNT, DLG_SZE, Destroy, DestroyChildren, Disable, DissociateHandle, DragAcceptFiles, Enable, FindWindowById, FindWindowByLabel, FindWindowByName, Fit, FitInside, Freeze, GetAcceleratorTable, GetAdjustedBestSize, GetAutoLayout, GetBackgroundColour, GetBackgroundStyle, GetBestFittingSize, GetBestSize, GetBestSizeTuple, GetBestVirtualSize, GetBorder, GetCaret, GetCharHeight, GetCharWidth, GetChildren, GetClientAreaOrigin, GetClientRect, GetClientSize, GetClientSizeTuple, GetConstraints, GetContainingSizer, GetCursor, GetDefaultAttributes, GetDropTarget, GetEffectiveMinSize, GetEventHandler, GetExtraStyle, GetFont, GetForegroundColour, GetFullTextExtent, GetGrandParent, GetGtkWidget, GetHandle, GetHelpText, GetHelpTextAtPoint, GetId, GetLabel, GetLayoutDirection, GetMainWindowOfCompositeControl, GetMaxClientSize, GetMaxHeight, GetMaxSize, GetMaxWidth, GetMinClientSize, GetMinHeight, GetMinSize, GetMinWidth, GetName, GetNextSibling, GetParent, GetPopupMenuSelectionFromUser, GetPosition, GetPositionTuple, GetPrevSibling, GetRect, GetScreenPosition, GetScreenPositionTuple, GetScreenRect, GetScrollPos, GetScrollRange, GetScrollThumb, GetSize, GetSizeTuple, GetSizer, GetTextExtent, GetThemeEnabled, GetToolTip, GetToolTipString, GetTopLevelParent, GetUpdateClientRect, GetUpdateRegion, GetValidator, GetVirtualSize, GetVirtualSizeTuple, GetWindowBorderSize, GetWindowStyle, GetWindowStyleFlag, GetWindowVariant, HandleAsNavigationKey, HandleWindowEvent, HasCapture, HasExtraStyle, HasFlag, HasFocus, HasMultiplePages, HasScrollbar, HasTransparentBackground, Hide, HideWithEffect, HitTest, HitTestXY, InformFirstDirection, InheritAttributes, InheritsBackgroundColour, InitDialog, InvalidateBestSize, IsBeingDeleted, IsDoubleBuffered, IsEnabled, IsExposed, IsExposedPoint, IsExposedRect, IsFrozen, IsRetained, IsScrollbarAlwaysShown, IsShown, IsShownOnScreen, IsThisEnabled, IsTopLevel, Layout, LineDown, LineUp, Lower, MakeModal, Move, MoveAfterInTabOrder, MoveBeforeInTabOrder, MoveXY, Navigate, NavigateIn, PageDown, PageUp, PopEventHandler, PopupMenu, PopupMenuXY, PostCreate, PostSizeEvent, PostSizeEventToParent, ProcessWindowEvent, PushEventHandler, Raise, Refresh, RefreshRect, RegisterHotKey, ReleaseMouse, RemoveChild, RemoveEventHandler, Reparent, ScreenToClient, ScreenToClientXY, ScrollLines, ScrollPages, ScrollWindow, SendIdleEvents, SendSizeEvent, SendSizeEventToParent, SetAcceleratorTable, SetAutoLayout, SetBackgroundColour, SetBackgroundStyle, SetBestFittingSize, SetCanFocus, SetCaret, SetClientRect, SetClientSize, SetClientSizeWH, SetConstraints, SetContainingSizer, SetCursor, SetDimensions, SetDoubleBuffered, SetDropTarget, SetEventHandler, SetExtraStyle, SetFocus, SetFocusFromKbd, SetFont, SetForegroundColour, SetHelpText, SetHelpTextForId, SetId, SetInitialSize, SetLabel, SetLayoutDirection, SetMaxClientSize, SetMaxSize, SetMinClientSize, SetMinSize, SetName, SetOwnBackgroundColour, SetOwnFont, SetOwnForegroundColour, SetPosition, SetRect, SetScrollPos, SetScrollbar, SetSize, SetSizeHints, SetSizeHintsSz, SetSizeWH, SetSizer, SetSizerAndFit, SetThemeEnabled, SetToolTip, SetToolTipString, SetTransparent, SetValidator, SetVirtualSize, SetVirtualSizeHints, SetVirtualSizeHintsSz, SetVirtualSizeWH, SetWindowStyle, SetWindowStyleFlag, SetWindowVariant, ShouldInheritColours, Show, ShowWithEffect, Thaw, ToggleWindowStyle, TransferDataFromWindow, TransferDataToWindow, UnregisterHotKey, UnsetToolTip, Update, UpdateWindowUI, UseBgCol, Validate, WarpPointer, WindowToClientSize

Inherited from wx._core.EvtHandler: AddPendingEvent, Bind, Connect, DeletePendingEvents, Disconnect, GetEvtHandlerEnabled, GetNextHandler, GetPreviousHandler, IsUnlinked, ProcessEvent, ProcessEventLocally, ProcessPendingEvents, QueueEvent, SafelyProcessEvent, SetEvtHandlerEnabled, SetNextHandler, SetPreviousHandler, Unbind, Unlink

Inherited from wx._core.EvtHandler (private): _setOORInfo

Inherited from wx._core.Object: GetClassName, IsSameAs

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]

Inherited from wx._windows.Frame: GetClassDefaultAttributes

Inherited from wx._windows.TopLevelWindow: GetDefaultSize

Inherited from wx._core.Window: FindFocus, GetCapture, NewControlId, ReleaseControlId, UnreserveControlId

Class Variables [hide private]
  min_width = 1000
  min_height = 600
Properties [hide private]

Inherited from wx._windows.Frame: MenuBar, StatusBar, StatusBarPane, ToolBar, thisown

Inherited from wx._windows.TopLevelWindow: DefaultItem, Icon, OSXModified, Title, TmpDefaultItem

Inherited from wx._core.Window: AcceleratorTable, AutoLayout, BackgroundColour, BackgroundStyle, BestSize, BestVirtualSize, Border, Caret, CharHeight, CharWidth, Children, ClientAreaOrigin, ClientRect, ClientSize, Constraints, ContainingSizer, Cursor, DefaultAttributes, DropTarget, EffectiveMinSize, Enabled, EventHandler, ExtraStyle, Font, ForegroundColour, GrandParent, GtkWidget, Handle, HelpText, Id, Label, LayoutDirection, MaxClientSize, MaxHeight, MaxSize, MaxWidth, MinClientSize, MinHeight, MinSize, MinWidth, Name, Parent, Position, Rect, ScreenPosition, ScreenRect, Shown, Size, Sizer, ThemeEnabled, ToolTip, ToolTipString, TopLevel, TopLevelParent, UpdateClientRect, UpdateRegion, Validator, VirtualSize, WindowStyle, WindowStyleFlag, WindowVariant

Inherited from wx._core.EvtHandler: EvtHandlerEnabled, NextHandler, PreviousHandler

Inherited from wx._core.Object: ClassName

Inherited from object: __class__

Method Details [hide private]

__init__(self, parent=None, id=-1, title='')
(Constructor)

source code 

Initialise the main relax GUI frame.

Returns: EvtHandler
Overrides: object.__init__

about_relax(self, event=None)

source code 

The about message for relax.

Parameters:
  • event (wx event) - The wx event.

action_export_bmrb(self, event=None)

source code 

Export the contents of the current data pipe for BMRB deposition.

Parameters:
  • event (wx event) - The wx event.

action_state_save(self, event=None)

source code 

Save the program state.

Parameters:
  • event (wx event) - The wx event.

action_state_save_as(self, event=None)

source code 

Save the program state with file name selection.

Parameters:
  • event (wx event) - The wx event.

close_windows(self)

source code 

Throw a warning to close all of the non-essential windows when execution is locked.

This is to speed up the calculations by avoiding window updates.

contact_relax(self, event=None)

source code 

Write an email to the relax mailing-list using the standard mailing program.

Parameters:
  • event (wx event) - The wx event.

exit_gui(self, event=None)

source code 

Catch the main window closure and perform the exit procedure.

Parameters:
  • event (wx event) - The wx event.

free_file_format_settings(self, event=None)

source code 

Open the free file format settings window.

Parameters:
  • event (wx event) - The wx event.

references(self, event=None)

source code 

Display the references relevant for relax.

Parameters:
  • event (wx event) - The wx event.

relax_manual(self, event=None)

source code 

Display the relax manual.

Parameters:
  • event (wx event) - The wx event.

run_test_suite(self, event=None, categories=['system', 'unit', 'gui', 'verification'])

source code 

Execute the full test suite.

Parameters:
  • event (wx event) - The wx event.
  • categories (list of str) - The list of test categories to run, for example ['system', 'unit', 'gui', 'verification'] for all tests.

run_test_suite_gui(self, event=None)

source code 

Execute the GUI tests.

Parameters:
  • event (wx event) - The wx event.

run_test_suite_sys(self, event=None)

source code 

Execute the system tests.

Parameters:
  • event (wx event) - The wx event.

run_test_suite_unit(self, event=None)

source code 

Execute the unit tests.

Parameters:
  • event (wx event) - The wx event.

run_test_suite_verification(self, event=None)

source code 

Execute the verification tests.

Parameters:
  • event (wx event) - The wx event.

show_controller(self, event=None)

source code 

Display the relax controller window.

Parameters:
  • event (wx event) - The wx event.

show_pipe_editor(self, event=None)

source code 

Display the data pipe editor window.

Parameters:
  • event (wx event) - The wx event.

show_prompt(self, event=None)

source code 

Display the relax prompt window.

Parameters:
  • event (wx event) - The wx event.

show_results_viewer(self, event=None)

source code 

Display the analysis results.

Parameters:
  • event (wx event) - The wx event.

show_results_viewer_safe(self, warn=False)

source code 

Display the analysis results in a thread safe wx.CallAfter call.

Parameters:
  • warn (bool) - A flag which if True will cause a message dialog to appear warning about keeping the window open with the execution lock.

show_tree(self, event=None)

source code 

Display the molecule, residue, and spin tree window.

Parameters:
  • event (wx event) - The wx event.

state_load(self, event=None, file_name=None)

source code 

Load the program state.

Parameters:
  • event (wx event) - The wx event.
  • file_name (str) - The name of the file to load (for dialogless operation).

sync_ds(self, upload=False)

source code 

Synchronise the GUI and the relax data store, both ways.

This method allows the GUI information to be uploaded into the relax data store, or for the information in the relax data store to be downloaded by the GUI.

Parameters:
  • upload (bool) - A flag which if True will cause the GUI to send data to the relax data store. If False, data will be downloaded from the relax data store to update the GUI.

uf_call(self, event=None)

source code 

Catch the user function call to properly specify the parent window.

Parameters:
  • event (wx event) - The wx event.

   Trees       Indices       Help   
relax
Generated by Epydoc 3.0.1 on Wed Sep 30 14:40:58 2015 http://epydoc.sourceforge.net