notebook.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
try:
    import wx.lib.agw.aui.auibook as aui
except ImportError:
    import wx.lib.agw.aui as aui
 
from wx import Colour
 
from ..publish import RideNotebookTabChanging, RideNotebookTabChanged
 
 
class NoteBook(aui.AuiNotebook):
 
    def __init__(self, parent, app, style):
        self._app_app = app
        self._notebook_style_notebook_style = style
        # style = fnb.FNB_NODRAG|fnb.FNB_HIDE_ON_SINGLE_TAB|fnb.FNB_VC8
        # fnb.FlatNotebook.__init__(self, parent, style=style)
        # default style=0, experiment others
        aui.AuiNotebook.__init__(self, parent, style=3, agwStyle=self._notebook_style_notebook_style)
        """
        self.SetBackgroundColour(Colour(200, 222, 40))
        self.SetOwnBackgroundColour(Colour(200, 222, 40))
        self.SetForegroundColour(Colour(7, 0, 70))
        self.SetOwnForegroundColour(Colour(7, 0, 70))
        """
        # self.SetBackgroundColour(parent.color_background_help)
        # print(f"DEBUG: Notebook  parent.color_background_help {parent.color_background_help}")
        # self.SetForegroundColour(parent.color_foreground_text)
        self.Bind(aui.EVT_AUINOTEBOOK_PAGE_CLOSE, self.OnTabClosingOnTabClosing)
        self.Bind(aui.EVT_AUINOTEBOOK_PAGE_CHANGING, self.OnTabChangingOnTabChanging)
        self.Bind(aui.EVT_AUINOTEBOOK_PAGE_CHANGED, self.OnTabChangedOnTabChanged)
        self._tab_closing_tab_closing = False
        self._tab_state_tab_state = None
        self._uncloseable_uncloseable = []
 
    def add_tab(self, tab, title, allow_closing=True):
        if not allow_closing:
            self._uncloseable_uncloseable.append(tab)
        self.AddPage(tab, title.strip())
 
    
    def show_tab(self, tab):
        if not self.tab_is_visibletab_is_visible(tab):
            page = self.GetPageIndex(tab)
            if page >= 0:
                self.SetSelection(page)
 
    def delete_tab(self, tab):
        if tab in self._uncloseable_uncloseable:
            self._uncloseable_uncloseable.remove(tab)
        page = self.GetPageIndex(tab)
        self.DeletePage(page)
 
    def rename_tab(self, tab, new_name):
        self.SetPageText(self.GetPageIndex(tab), new_name)
 
    def allow_closing(self, tab):
        if tab in self._uncloseable_uncloseable:
            self._uncloseable_uncloseable.remove(tab)
 
    def disallow_closing(self, tab):
        if tab not in self._uncloseable_uncloseable:
            self._uncloseable_uncloseable.append(tab)
 
    def tab_is_visible(self, tab):
        return tab == self.GetCurrentPage()
 
    @property
    current_page_title = property
    
    def current_page_title(self):
        return self.GetPageText(self.GetSelection())
 
    def OnTabClosing(self, event):
        if self.GetPage(event.GetSelection()) in self._uncloseable_uncloseable:
            event.Veto()
            return
        self._tab_closing_tab_closing = True
 
    def OnTabChanging(self, event):
        if not self._tab_changed_tab_changed():
            return
        oldselect = event.GetOldSelection()
        try:
            oldtitle = self.GetPageText(oldselect)
        except Exception:
            oldtitle = ""
        newindex = event.GetSelection()
        newtitle = self.GetPageText(event.GetSelection())
        if self._tab_state_tab_state is not None:
            if self._tab_state_tab_state == oldtitle + newtitle + str(newindex):
                return
            else:
                self._tab_state_tab_state = oldtitle + newtitle + str(newindex)
        else:
            self._tab_state_tab_state = newtitle + str(newindex)
        self.GetPage(event.GetSelection()).SetFocus()
        RideNotebookTabChanging(oldtab=oldtitle, newtab=newtitle).publish()
        event.Skip()
 
    def OnTabChanged(self, event):
        if not self._tab_changed_tab_changed():
            self._tab_closing_tab_closing = False
            return
        RideNotebookTabChanged().publish()
 
    
    def _tab_changed(self):
        if not self.GetPageCount() or self._tab_closing_tab_closing:
            return False
        return True