ControlNotebook.py

# -*- coding: utf-8 -*-

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
# ControlNotebook.py ---
#                     --------------------------------
#                        Copyright (c) 2013
#                       Laurent CAPOCCHI
#                      University of Corsica
#                     --------------------------------
# Version 1.0                                        last modified: 10/11/2013
## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
#
# GENERAL NOTES AND REMARKS:
#
## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
#
# GLOBAL VARIABLES AND FUNCTIONS
#
## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

import wx
import os

import gettext
_ = gettext.gettext

from Patterns.Observer import Observer
from LibPanel import LibPanel
from PropPanel import PropPanel
from AttributeEditor import AttributeEditor
from Mixins.Attributable import Attributable

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
#
# CLASSES DEFINITION
#
## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

### --------------------------------------------------------------------------
class GeneralNotebook(Observer):
	def __init__(self, *args, **kwargs):
		"""
		General Notebook class for Control NoteBook on the left part of DEVSimPy
		"""

		### label list
		self.labelList = (_("Libraries"), _("Properties"))

		### Create panels with name used for label tab definition...
		libPanel = LibPanel(self, self.labelList[0])
		propPanel = PropPanel(self, self.labelList[1])

		### selected model for libPanel managing
		self.selected_model = None

		self.__set_properties()

		### must be invoked here, at the end of constructor
		self.AddPage(libPanel, libPanel.GetName(), imageId=0)
		self.AddPage(propPanel, propPanel.GetName(), imageId=1)

		### binding event
		self.Bind(wx.EVT_NOTEBOOK_PAGE_CHANGED, self.__PageChanged)

	def __set_properties(self):
		"""
		"""
		imgList = wx.ImageList(16, 16)
		for img in [os.path.join(ICON_PATH_16_16,'db.png'), os.path.join(ICON_PATH_16_16, 'properties.png'), os.path.join(ICON_PATH_16_16,'simulation.png')]:
			imgList.Add(wx.Bitmap(img))
		self.AssignImageList(imgList)

	def __PageChanged(self, evt):
		"""
		"""
		if evt.GetSelection() == 1:
			pass
		evt.Skip()

	def GetLibPanel(self):
		""" Get Libraries panel if exist
		"""
		### list of label of all existing panel
		labelList = [self.GetPageText(a) for a in iter(range(self.GetPageCount()))]
		try:
			### try to find if panel exist from label
			index = labelList.index(self.labelList[0])
		except ValueError as info:
			### index not match, panel not existing
			return None
		else:
			### return the Panel object from the founded index
			return self.GetPage(index)

	def GetPropPanel(self):
		""" Get Properties panel if exist
		"""
		### list of label of all existing panel
		labelList = [self.GetPageText(a) for a in iter(range(self.GetPageCount()))]
		try:
			### try to find if panel exist from label
			index = labelList.index(self.labelList[1])
		except ValueError as info:
			### index not match, panel not existing
			return None
		else:
			### return the Panel object from the founded index
			return self.GetPage(index)

	def GetSimPanel(self):
		""" Get Simulation panel if exist
		"""
		### list of label of all existing panel
		labelList = [self.GetPageText(a) for a in iter(range(self.GetPageCount()))]
		try:
			### try to find if panel exist from label
			index = labelList.index(self.labelList[2])
		except ValueError as info:
			### index not match, panel not existing
			return None
		else:
			### return the Panel object from the founded index
			return self.GetPage(index)

	def GetTree(self):
		""" Get tree attribute from libraries panel
		"""
		libPanel = self.GetLibPanel()
		return libPanel.tree if libPanel else None

	def GetSearchTree(self):
		""" Get search tree attribute from libraries panel
		"""
		libPanel = self.GetLibPanel()
		return libPanel.searchTree if libPanel else None

	def GetSearch(self):
		""" Get search attribute from libraries panel
		"""
		libPanel = self.GetLibPanel()
		return libPanel.search

	def update(self, concret_subject=None):
		""" Update method that manages the panel properties depending of the selected model in the canvas
		"""

		state = concret_subject.GetState()
		canvas = state['canvas']
		model = state['model']

		propPanel = self.GetPropPanel()
		
		### update only of panel properties is present (but not necessarily active)
		if propPanel:
			str=None
			if isinstance(model, Attributable):
				if model != self.selected_model:
					newContent = AttributeEditor(propPanel, wx.NewIdRef(), model, canvas)
					propPanel.UpdatePropertiesPage(newContent)
					
					self.selected_model = model
					str = propPanel.propToolTip[1]
			else:
				propPanel.UpdatePropertiesPage(propPanel.defaultPropertiesPage())
				self.selected_model = None
				str = propPanel.propToolTip[0]
			
			if str : propPanel.SetToolTipString(str) if wx.VERSION_STRING < '4.0' else propPanel.SetToolTip(str)

### ---------------------------------------------
### if flatnotebook can be imported, we work with it
### more information about FlatNotebook http://wiki.wxpython.org/Flatnotebook%20(AGW)

USE_FLATNOTEBOOK = False

try:
	if (wx.VERSION >= (2, 8, 9, 2)):
		import wx.lib.agw.flatnotebook as fnb
	else:
		import wx.lib.flatnotebook as fnb
	USE_FLATNOTEBOOK = True
except:
	pass

MENU_EDIT_DELETE_PAGE = wx.NewIdRef()

if USE_FLATNOTEBOOK:
	#-------------------------------------------------------------------
	class ControlNotebook(fnb.FlatNotebook, GeneralNotebook):
		"""
		"""

		def __init__(self, *args, **kwargs):
			"""
			FlatNotebook class that allows overriding and adding methods for the left pane of DEVSimPy
			"""

			fnb.FlatNotebook.__init__(self, *args, **kwargs)
			GeneralNotebook.__init__(self)

			### FlatNotebook can be styled
			self.SetWindowStyleFlag(fnb.FNB_DROPDOWN_TABS_LIST|\
									fnb.FNB_FF2|\
									fnb.FNB_SMART_TABS|\
									fnb.FNB_X_ON_TAB|\
									fnb.FNB_HIDE_ON_SINGLE_TAB)

			self.Bind(fnb.EVT_FLATNOTEBOOK_PAGE_CLOSING, self.__OnClosingPage)

			self.CreateRightClickMenu()
			self.SetRightClickMenu(self._rmenu)

		def __OnClosingPage(self, evt):
			""" The close button of FlatNotebook has been invoked.
				We update the Show menu depending on the deleted tab.
			"""

			mainW = wx.GetApp().GetTopWindow()

			### label which will be deleted
			label = self.GetPageText(evt.GetSelection())

			### find the corresponding sub-menu in the Show menu and deselect the label
			### Show menu is in position 2 on the Menu Bar of DEVSimPy
			show_menu = mainW.GetMenuBar().GetMenu(2)
			### Control menu is in position 0 (first)
			control_item = show_menu.FindItemByPosition(0)
			### list of sub-menu for the Control menu
			items_list = control_item.GetSubMenu().GetMenuItems()
			### for all items (Simulation, Properties, Libraries)
			for item in items_list:
				### if label that will be deleted is equal to the label of current item, we deselect it
				if item.GetItemLabel() == label:
					item.Check(False)

		def __OnClosePage(self, evt):
			"""
			"""
			self.DeletePage(self.GetSelection())

		def CreateRightClickMenu(self):
			"""
			"""
			self._rmenu = wx.Menu()
			item = wx.MenuItem(self._rmenu, MENU_EDIT_DELETE_PAGE, _("Close\tCtrl+F4"), _("Close Tab"))
			if wx.VERSION_STRING < '4.0': 
				self._rmenu.AppendItem(item) 
			else:
				self._rmenu.Append(item) 
			self.Bind(wx.EVT_MENU, self.__OnClosePage, item)

else:

	#-------------------------------------------------------------------
	class ControlNotebook(wx.Notebook, GeneralNotebook):
		"""
		"""

		def __init__(self, *args, **kwargs):
			"""
			Notebook class that allows overriding and adding methods for the left pane of DEVSimPy.
			"""

			wx.Notebook.__init__(self, *args, **kwargs)
			GeneralNotebook.__init__(self)