Source code for sas.sasgui.guiframe.panel_base



################################################################################
#This software was developed by the University of Tennessee as part of the
#Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
#project funded by the US National Science Foundation. 
#
#See the license text in license.txt
#
#copyright 2008, University of Tennessee
################################################################################


from sas.sasgui.guiframe.events import PanelOnFocusEvent
from sas.sasgui.guiframe.events import EVT_NEW_BATCH
import wx

[docs]class PanelBase: """ Defines the API for a panels to work with the ViewerFrame toolbar and menu bar """ ## Internal nickname for the window, used by the AUI manager #window_name = "default" ## Name to appear on the window title bar #window_caption = "Welcome panel" ## Flag to tell the AUI manager to put this panel in the center pane group_id = None uid = None def __init__(self, parent=None): """ Initialize some flag that Viewerframe used """ #panel manager self._manager = None self.parent = parent if self.parent is not None and hasattr(self.parent, '_manager'): self._manager = self.parent._manager self._print_flag = False self._undo_flag = False self._redo_flag = False self._copy_flag = False self._paste_flag = False self._preview_flag = False self._bookmark_flag = False self._zoom_in_flag = False self._zoom_out_flag = False self._zoom_flag = False self._save_flag = False self._drag_flag = False self._reset_flag = False self._has_changed = False self.batch_on = False if self.parent is not None and hasattr(self.parent, "batch_on"): self.batch_on = self.parent.batch_on self.group_id = None self.help_string = ''
[docs] def on_batch_selection(self, event): """ :param event: contains parameter enable. When enable is set to True the application is in Batch mode otherwise the application is in Single mode. """ self.batch_on = event.enable
[docs] def save_project(self, doc=None): """ return an xml node containing state of the panel that guiframe can write to file """ return None
[docs] def has_changed(self): """ """ return self._has_changed
def _set_print_flag(self, flag=True): """ The derivative class sets the print flag value to indicate that it can be printed """ if flag == self._print_flag: self._has_changed = False return self._has_changed = True self._print_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_print()
[docs] def get_print_flag(self): """ Get the print flag to update appropriately the tool bar """ return self._print_flag
def _set_undo_flag(self, flag=True): """ The derivative class sets the undo flag value to indicate that the current action done can be canceled """ if flag == self._undo_flag: self._has_changed = False return self._has_changed = True self._undo_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_undo()
[docs] def get_undo_flag(self): """ Get the undo flag to update appropriately the tool bar """ return self._undo_flag
def _set_redo_flag(self, flag=True): """ The derivative class sets the redo flag value to indicate that the action done can be recovered """ if flag == self._redo_flag: self._has_changed = False return self._has_changed = True self._redo_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_redo()
[docs] def get_redo_flag(self): """ Get the redo flag to update appropriately the tool bar """ return self._redo_flag
def _set_copy_flag(self, flag=True): """ The derivative class sets the copy flag value to indicate that the action done can be recovered """ if flag == self._copy_flag: self._has_changed = False return self._has_changed = True self._copy_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_copy()
[docs] def get_copy_flag(self): """ Get the copy flag to update appropriately the tool bar """ return self._copy_flag
def _set_paste_flag(self, flag=True): """ The derivative class sets the paste flag value to indicate that the action done can be recovered """ if flag == self._paste_flag: self._has_changed = False return self._has_changed = True self._paste_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_paste()
[docs] def get_paste_flag(self): """ Get the copy flag to update appropriately the tool bar """ return self._copy_flag
def _set_zoomed_in_flag(self, flag=True): """ The derivative class sets the zoom in flag value to indicate that it can be zoomed in """ if self._zoom_in_flag == flag: self._has_changed = False return self._has_changed = True self._zoom_in_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_zoom_in()
[docs] def get_zoom_in_flag(self): """ Get the zoom in flag to update appropriately the tool bar """ return self._zoom_in_flag
def _set_zoomed_out_flag(self, flag=True): """ The derivative class sets the zoom out flag value to indicate that it can be zoomed out """ if self._zoom_out_flag == flag: self._has_changed = False return self._has_changed = True self._zoom_out_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.panel_on_focus = self self._manager.parent.enable_zoom_out()
[docs] def get_zoom_out_flag(self): """ Get the zoom out flag to update appropriately the tool bar """ return self._zoom_out_flag
def _set_zoom_flag(self, flag=True): """ The derivative class sets the zoom flag value to indicate that it can be zoomed """ if flag == self._zoom_flag: self._has_changed = False return self._has_changed = True self._zoom_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_zoom()
[docs] def get_zoom_flag(self): """ Get the zoom flag to update appropriately the tool bar """ return self._zoom_flag
def _set_bookmark_flag(self, flag=True): """ The derivative class sets the bookmark flag value to indicate that it can be bookmarked """ if flag == self._bookmark_flag: self._has_changed = False return self._has_changed = True self._bookmark_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_bookmark()
[docs] def get_bookmark_flag(self): """ Get the bookmark flag to update appropriately the tool bar """ return self._bookmark_flag
def _set_preview_flag(self, flag=True): """ The derivative class sets the preview flag value to indicate that it can be previewed """ if flag == self._preview_flag: self._has_changed = False return self._has_changed = True self._preview_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_preview()
[docs] def get_preview_flag(self): """ Get the preview flag to update appropriately the tool bar """ return self._preview_flag
def _set_save_flag(self, flag=True): """ The derivative class sets the drag flag value to indicate that it can be saved """ if flag == self._save_flag: self._has_changed = False return self._has_changed = True self._save_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_save()
[docs] def get_save_flag(self): """ Get the save flag to update appropriately the tool bar """ return self._save_flag
def _set_drag_flag(self, flag=True): """ The derivative class sets the drag flag value to indicate that dragging motion is possible """ if self._drag_flag == flag: self._has_changed = False return self._has_changed = True self._drag_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_drag()
[docs] def get_drag_flag(self): """ Get the drag flag to update appropriately the tool bar """ return self._drag_flag
def _set_analysis(self, flag): """ Set the Analysis Save state flag and informs the manager so it refreshes the menu/whole panel """ self._set_save_flag(flag) if self._manager is not None: wx.PostEvent(self._manager.parent, PanelOnFocusEvent(panel=self)) def _set_reset_flag(self, flag=True): """ The derivative class sets the reset flag value to indicate that it can be reset """ if self._reset_flag == flag: self._has_changed = False return self._has_changed = True self._reset_flag = flag if self._manager is not None and self._manager.parent is not None: self._manager.parent.cpanel_on_focus = self self._manager.parent.enable_reset()
[docs] def on_tap_focus(self): """ Update menu on clicking the panel tap """ #Implemented only on fitting note book pass
[docs] def get_reset_flag(self): """ Get the reset flag to update appropriately the tool bar """ return self._reset_flag
[docs] def on_reset(self, event): """ The derivative class state is restored """
[docs] def on_drag(self, event): """ The derivative class allows dragging motion if implemented """
[docs] def on_preview(self, event): """ Display a printable version of the class derivative """
[docs] def on_save(self, event): """ The state of the derivative class is restored """
[docs] def on_redo(self, event): """ The previous action is restored if possible """
[docs] def on_undo(self, event): """ The current action is canceled """
[docs] def on_copy(self, event): """ The copy action if possible """
[docs] def on_paste(self, event): """ The paste action if possible """
[docs] def on_bookmark(self, event): """ The derivative class is on bookmark mode if implemented """
[docs] def on_zoom_in(self, event): """ The derivative class is on zoom in mode if implemented """
[docs] def on_zoom_out(self, event): """ The derivative class is on zoom out mode if implemented """
[docs] def on_zoom(self, event): """ The derivative class is on zoom mode (using pane) if zoom mode is implemented """
[docs] def on_set_focus(self, event=None): """ The derivative class is on focus if implemented """ if self.parent is not None: wx.PostEvent(self.parent, PanelOnFocusEvent(panel=self))
[docs] def on_kill_focus(self, event=None): """ The derivative class is on unfocus if implemented """ pass
[docs] def get_data(self): """ return list of current data """ return
[docs] def get_state(self): """ return the current state """ return
[docs] def set_manager(self, manager): """ """ self._manager = manager
[docs] def get_manager(self): """ """ return self._manager
[docs] def get_frame(self): """ """ if self._manager is None: return None return self._manager.frame
[docs] def on_close(self, event): """ Close event. Hide the whole window. """ parent = self.GetParent() if parent is not None: parent.Hide()