Sneed-Group/Poodletooth-iLand
1
0
Fork 0
mirror of https://github.com/Sneed-Group/Poodletooth-iLand synced 2024-12-29 06:32:40 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions
Poodletooth-iLand/panda/python/Lib/site-packages/wx/lib/agw/ribbon/bar.py
Zach 10cf2f553e added wx, setuptools, and pip
2015-03-06 06:11:40 -06:00

1260 lines
51 KiB
Python
Raw Blame History

# -*- coding: utf-8 -*-
#----------------------------------------------------------------------------
# Name: bar.py
# Licence: wxWindows license
#
# Tags: phoenix-port, unittest, documented, py3-port
#
# RIBBONBAR Library wxPython IMPLEMENTATION
#
# Original C++ Code From Peter Cawley.
#
# Current wxRibbon Version Tracked: wxWidgets 2.9.0 SVN HEAD
#
#
# Python Code By:
#
# Andrea Gavana, @ 15 Oct 2009
# Latest Revision: 27 Dec 2012, 21.00 GMT
#
# For All Kind Of Problems, Requests Or Enhancements And Bug Reports, Please
# Write To Me At:
#
# andrea.gavana@gmail.com
# andrea.gavana@maerskoil.com
#
# Or, Obviously, To The wxPython Mailing List!!!
#
# End Of Comments
#---------------------------------------------------------------------------
"""
Top-level control in a ribbon user interface.
Description
===========
Serves as a tabbed container for :class:`~lib.agw.ribbon.page.RibbonPage` - a ribbon user interface typically
has a ribbon bar, which contains one or more RibbonPages, which in turn each contains
one or more RibbonPanels, which in turn contain controls. While a :class:`RibbonBar` has
tabs similar to a :class:`Notebook`, it does not follow the same API for adding pages.
Containers like :class:`Notebook` can contain any type of window as a page, hence the
normal procedure is to create the sub-window and then call :meth:`BookCtrlBase.AddPage` ().
As :class:`RibbonBar` can only have :class:`~lib.agw.ribbon.page.RibbonPage` as children
(and a :class:`~lib.agw.ribbon.page.RibbonPage` can only have a :class:`RibbonBar` as parent),
when a page is created, it is automatically added to the bar - there is no `AddPage` equivalent to call.
After all pages have been created, and all controls and panels placed on those pages,
:meth:`~RibbonBar.Realize` must be called.
Window Styles
=============
This class supports the following window styles:
========================================== =========== ==========================================
Window Styles Hex Value Description
========================================== =========== ==========================================
``RIBBON_BAR_DEFAULT_STYLE`` 0x9 Defined as ``RIBBON_BAR_FLOW_HORIZONTAL`` | ``RIBBON_BAR_SHOW_PAGE_LABELS`` | ``RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS``
``RIBBON_BAR_FOLDBAR_STYLE`` 0x1e Defined as ``RIBBON_BAR_FLOW_VERTICAL`` | ``RIBBON_BAR_SHOW_PAGE_ICONS`` | ``RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS`` | ``RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS``
``RIBBON_BAR_SHOW_PAGE_LABELS`` 0x1 Causes labels to be shown on the tabs in the ribbon bar.
``RIBBON_BAR_SHOW_PAGE_ICONS`` 0x2 Causes icons to be shown on the tabs in the ribbon bar.
``RIBBON_BAR_FLOW_HORIZONTAL`` 0x0 Causes panels within pages to stack horizontally.
``RIBBON_BAR_FLOW_VERTICAL`` 0x4 Causes panels within pages to stack vertically.
``RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS`` 0x8 Causes extension buttons to be shown on panels (where the panel has such a button).
``RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS`` 0x10 Causes minimise buttons to be shown on panels (where the panel has such a button).
``RIBBON_BAR_ALWAYS_SHOW_TABS`` 0x20 Always shows the tabs area even when only one tab is added.
========================================== =========== ==========================================
Events Processing
=================
This class processes the following events:
================================= =================================
Event Name Description
================================= =================================
``EVT_RIBBONBAR_PAGE_CHANGED`` Triggered after the transition from one page being active to a different page being active.
``EVT_RIBBONBAR_PAGE_CHANGING`` Triggered prior to the transition from one page being active to a different page being active, and can veto the change.
``EVT_RIBBONBAR_TAB_MIDDLE_DOWN`` Triggered when the middle mouse button is pressed on a tab.
``EVT_RIBBONBAR_TAB_MIDDLE_UP`` Triggered when the middle mouse button is released on a tab.
``EVT_RIBBONBAR_TAB_RIGHT_DOWN`` Triggered when the right mouse button is pressed on a tab.
``EVT_RIBBONBAR_TAB_RIGHT_UP`` Triggered when the right mouse button is released on a tab.
``EVT_RIBBONBAR_TAB_LEFT_DCLICK`` Triggered when the user double-clicks on a tab.
================================= =================================
See Also
========
:class:`~lib.agw.ribbon.page.RibbonPage`, :class:`~lib.agw.ribbon.panel.RibbonPanel`
"""
import wx
import wx.lib.six as six
from .control import RibbonControl
from .art_internal import RibbonPageTabInfo
from .art_msw import RibbonMSWArtProvider
from .art import *
wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGED = wx.NewEventType()
wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGING = wx.NewEventType()
wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_DOWN = wx.NewEventType()
wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_UP = wx.NewEventType()
wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_DOWN = wx.NewEventType()
wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_UP = wx.NewEventType()
wxEVT_COMMAND_RIBBONBAR_TAB_LEFT_DCLICK = wx.NewEventType()
EVT_RIBBONBAR_PAGE_CHANGED = wx.PyEventBinder(wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGED, 1)
EVT_RIBBONBAR_PAGE_CHANGING = wx.PyEventBinder(wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGING, 1)
EVT_RIBBONBAR_TAB_MIDDLE_DOWN = wx.PyEventBinder(wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_DOWN, 1)
EVT_RIBBONBAR_TAB_MIDDLE_UP = wx.PyEventBinder(wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_UP, 1)
EVT_RIBBONBAR_TAB_RIGHT_DOWN = wx.PyEventBinder(wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_DOWN, 1)
EVT_RIBBONBAR_TAB_RIGHT_UP = wx.PyEventBinder(wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_UP, 1)
EVT_RIBBONBAR_TAB_LEFT_DCLICK = wx.PyEventBinder(wxEVT_COMMAND_RIBBONBAR_TAB_LEFT_DCLICK, 1)
def SET_FLAG(variable, flag):
refresh_tabs = False
if variable & flag != flag:
variable |= flag
refresh_tabs = True
return variable, refresh_tabs
def UNSET_FLAG(variable, flag):
refresh_tabs = False
if variable & flag:
variable &= ~flag
refresh_tabs = True
return variable, refresh_tabs
class RibbonBarEvent(wx.NotifyEvent):
"""
Event used to indicate various actions relating to a :class:`RibbonBar`.
.. seealso:: :class:`RibbonBar` for available event types.
"""
def __init__(self, command_type=None, win_id=0, page=None):
"""
Default class constructor.
:param integer `command_type`: the event type;
:param integer `win_id`: the event identifier;
:param `page`: an instance of :class:`~lib.agw.ribbon.page.RibbonPage`.
"""
wx.NotifyEvent.__init__(self, command_type, win_id)
self._page = page
self._isAllowed = True
def GetPage(self):
"""
Returns the page being changed to, or being clicked on.
:returns: An instance of :class:`~lib.agw.ribbon.page.RibbonPage`.
"""
return self._page
def SetPage(self, page):
"""
Sets the page relating to this event.
:param `page`: an instance of :class:`~lib.agw.ribbon.page.RibbonPage`.
"""
self._page = page
def Allow(self):
"""
This is the opposite of :meth:`~RibbonBarEvent.Veto`: it explicitly allows the event to be processed.
For most events it is not necessary to call this method as the events are
allowed anyhow but some are forbidden by default (this will be mentioned
in the corresponding event description).
"""
self._isAllowed = True
def Veto(self):
"""
Prevents the change announced by this event from happening.
:note: It is in general a good idea to notify the user about the reasons
for vetoing the change because otherwise the applications behaviour (which
just refuses to do what the user wants) might be quite surprising.
"""
self._isAllowed = False
def IsAllowed(self):
"""
Returns ``True`` if the change is allowed (:meth:`~RibbonBarEvent.Veto` hasn't been called) or
``False`` otherwise (if it was).
"""
return self._isAllowed
class RibbonBar(RibbonControl):
""" Top-level control in a ribbon user interface. """
def __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, agwStyle=RIBBON_BAR_DEFAULT_STYLE,
validator=wx.DefaultValidator, name="RibbonBar"):
"""
Default constructor.
:param `parent`: pointer to a parent window, must not be ``None``;
:type `parent`: :class:`Window`
:param integer `id`: window identifier. If ``wx.ID_ANY``, will automatically create
an identifier;
:param `pos`: window position. ``wx.DefaultPosition`` indicates that wxPython
should generate a default position for the window;
:type `pos`: tuple or :class:`Point`
:param `size`: window size. ``wx.DefaultSize`` indicates that wxPython should
generate a default size for the window. If no suitable size can be found, the
window will be sized to 20x20 pixels so that the window is visible but obviously
not correctly sized;
:type `size`: tuple or :class:`Size`
:param `agwStyle`: the AGW-specific window style. This can be a combination of the
following bits:
========================================== =========== ==========================================
Window Styles Hex Value Description
========================================== =========== ==========================================
``RIBBON_BAR_DEFAULT_STYLE`` 0x9 Defined as ``RIBBON_BAR_FLOW_HORIZONTAL`` | ``RIBBON_BAR_SHOW_PAGE_LABELS`` | ``RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS``
``RIBBON_BAR_FOLDBAR_STYLE`` 0x1e Defined as ``RIBBON_BAR_FLOW_VERTICAL`` | ``RIBBON_BAR_SHOW_PAGE_ICONS`` | ``RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS`` | ``RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS``
``RIBBON_BAR_SHOW_PAGE_LABELS`` 0x1 Causes labels to be shown on the tabs in the ribbon bar.
``RIBBON_BAR_SHOW_PAGE_ICONS`` 0x2 Causes icons to be shown on the tabs in the ribbon bar.
``RIBBON_BAR_FLOW_HORIZONTAL`` 0x0 Causes panels within pages to stack horizontally.
``RIBBON_BAR_FLOW_VERTICAL`` 0x4 Causes panels within pages to stack vertically.
``RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS`` 0x8 Causes extension buttons to be shown on panels (where the panel has such a button).
``RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS`` 0x10 Causes minimise buttons to be shown on panels (where the panel has such a button).
``RIBBON_BAR_ALWAYS_SHOW_TABS`` 0x20 Always shows the tabs area even when only one tab is added.
========================================== =========== ==========================================
:param `validator`: the window validator;
:type `validator`: :class:`Validator`
:param string `name`: the window name.
"""
RibbonControl.__init__(self, parent, id, pos, size, style=wx.NO_BORDER)
self._flags = 0
self._tabs_total_width_ideal = 0
self._tabs_total_width_minimum = 0
self._tab_margin_left = 0
self._tab_margin_right = 0
self._tab_height = 0
self._tab_scroll_amount = 0
self._current_page = -1
self._current_hovered_page = -1
self._tab_scroll_left_button_state = RIBBON_SCROLL_BTN_NORMAL
self._tab_scroll_right_button_state = RIBBON_SCROLL_BTN_NORMAL
self._tab_scroll_buttons_shown = False
self._arePanelsShown = True
self._pages = []
self.Bind(wx.EVT_ERASE_BACKGROUND, self.OnEraseBackground)
self.Bind(wx.EVT_LEAVE_WINDOW, self.OnMouseLeave)
self.Bind(wx.EVT_LEFT_DOWN, self.OnMouseLeftDown)
self.Bind(wx.EVT_LEFT_DCLICK, self.OnMouseDoubleClick)
self.Bind(wx.EVT_LEFT_UP, self.OnMouseLeftUp)
self.Bind(wx.EVT_MIDDLE_DOWN, self.OnMouseMiddleDown)
self.Bind(wx.EVT_MIDDLE_UP, self.OnMouseMiddleUp)
self.Bind(wx.EVT_MOTION, self.OnMouseMove)
self.Bind(wx.EVT_PAINT, self.OnPaint)
self.Bind(wx.EVT_RIGHT_DOWN, self.OnMouseRightDown)
self.Bind(wx.EVT_RIGHT_UP, self.OnMouseRightUp)
self.Bind(wx.EVT_SIZE, self.OnSize)
self.CommonInit(agwStyle)
def AddPage(self, page):
"""
Adds a page to the :class:`RibbonBar`.
:param `page`: an instance of :class:`~lib.agw.ribbon.page.RibbonPage`.
"""
info = RibbonPageTabInfo()
info.page = page
info.active = False
info.hovered = False
# info.rect not set (intentional)
dcTemp = wx.ClientDC(self)
label = ""
if self._flags & RIBBON_BAR_SHOW_PAGE_LABELS:
label = page.GetLabel()
icon = wx.NullBitmap
if self._flags & RIBBON_BAR_SHOW_PAGE_ICONS:
icon = page.GetIcon()
info.ideal_width, info.small_begin_need_separator_width, \
info.small_must_have_separator_width, info.minimum_width = self._art.GetBarTabWidth(dcTemp, self, label, icon, info.ideal_width,
info.small_begin_need_separator_width,
info.small_must_have_separator_width, info.minimum_width)
if not self._pages:
self._tabs_total_width_ideal = info.ideal_width
self._tabs_total_width_minimum = info.minimum_width
else:
sep = self._art.GetMetric(RIBBON_ART_TAB_SEPARATION_SIZE)
self._tabs_total_width_ideal += sep + info.ideal_width
self._tabs_total_width_minimum += sep + info.minimum_width
self._pages.append(info)
page.Hide() # Most likely case is that self new page is not the active tab
page.SetArtProvider(self._art)
if len(self._pages) == 1:
self.SetActivePage(0)
def DismissExpandedPanel(self):
"""
Dismiss the expanded panel of the currently active page.
Calls and returns the value from :meth:`RibbonPage.DismissExpandedPanel() <lib.agw.ribbon.page.RibbonPage.DismissExpandedPanel>` for the
currently active page, or ``False`` if there is no active page.
"""
if self._current_page == -1:
return False
return self._pages[self._current_page].page.DismissExpandedPanel()
def ShowPanels(self, show=True):
"""
Shows or hides the panels inside :class:`RibbonBar`.
:param bool `show`: ``True`` to show the panels, ``False`` to hide them.
"""
self._arePanelsShown = show
self.SetMinSize(wx.Size(self.GetSize().GetWidth(), self.DoGetBestSize().GetHeight()))
self.Realise()
self.GetParent().Layout()
def SetAGWWindowStyleFlag(self, agwStyle):
"""
Sets the window style for :class:`RibbonBar`.
:param integer `agwStyle`: can be a combination of the following bits:
========================================== =========== ==========================================
Window Styles Hex Value Description
========================================== =========== ==========================================
``RIBBON_BAR_DEFAULT_STYLE`` 0x9 Defined as ``RIBBON_BAR_FLOW_HORIZONTAL`` | ``RIBBON_BAR_SHOW_PAGE_LABELS`` | ``RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS``
``RIBBON_BAR_FOLDBAR_STYLE`` 0x1e Defined as ``RIBBON_BAR_FLOW_VERTICAL`` | ``RIBBON_BAR_SHOW_PAGE_ICONS`` | ``RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS`` | ``RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS``
``RIBBON_BAR_SHOW_PAGE_LABELS`` 0x1 Causes labels to be shown on the tabs in the ribbon bar.
``RIBBON_BAR_SHOW_PAGE_ICONS`` 0x2 Causes icons to be shown on the tabs in the ribbon bar.
``RIBBON_BAR_FLOW_HORIZONTAL`` 0x0 Causes panels within pages to stack horizontally.
``RIBBON_BAR_FLOW_VERTICAL`` 0x4 Causes panels within pages to stack vertically.
``RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS`` 0x8 Causes extension buttons to be shown on panels (where the panel has such a button).
``RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS`` 0x10 Causes minimise buttons to be shown on panels (where the panel has such a button).
``RIBBON_BAR_ALWAYS_SHOW_TABS`` 0x20 Always shows the tabs area even when only one tab is added.
========================================== =========== ==========================================
:note: Please note that some styles cannot be changed after the window creation
and that `Refresh()` might need to be be called after changing the others for
the change to take place immediately.
"""
self._flags = agwStyle
if self._art:
self._art.SetFlags(agwStyle)
def GetAGWWindowStyleFlag(self):
"""
Returns the :class:`RibbonBar` window style flag.
:see: :meth:`~RibbonBar.SetAGWWindowStyleFlag` for a list of valid window styles.
"""
return self._flags
def Realize(self):
"""
Perform initial layout and size calculations of the bar and its children.
This must be called after all of the bar's children have been created (and their
children created, etc.) - if it is not, then windows may not be laid out or
sized correctly. Also calls :meth:`RibbonPage.Realize() <lib.agw.ribbon.page.RibbonPage.Realize>`
on each child page.
:note: Reimplemented from :class:`~lib.agw.ribbon.control.RibbonControl`.
"""
status = True
dcTemp = wx.ClientDC(self)
sep = self._art.GetMetric(RIBBON_ART_TAB_SEPARATION_SIZE)
numtabs = len(self._pages)
for i, info in enumerate(self._pages):
self.RepositionPage(info.page)
if not info.page.Realize():
status = False
label = ""
if self._flags & RIBBON_BAR_SHOW_PAGE_LABELS:
label = info.page.GetLabel()
icon = wx.NullBitmap
if self._flags & RIBBON_BAR_SHOW_PAGE_ICONS:
icon = info.page.GetIcon()
info.ideal_width, info.small_begin_need_separator_width, \
info.small_must_have_separator_width, \
info.minimum_width = self._art.GetBarTabWidth(dcTemp, self, label, icon, info.ideal_width,
info.small_begin_need_separator_width, info.small_must_have_separator_width,
info.minimum_width)
if i == 0:
self._tabs_total_width_ideal = info.ideal_width
self._tabs_total_width_minimum = info.minimum_width
else:
self._tabs_total_width_ideal += sep + info.ideal_width
self._tabs_total_width_minimum += sep + info.minimum_width
self._tab_height = self._art.GetTabCtrlHeight(dcTemp, self, self._pages)
self.RecalculateMinSize()
self.RecalculateTabSizes()
self.Refresh()
return status
def OnMouseMove(self, event):
"""
Handles the ``wx.EVT_MOTION`` event for :class:`RibbonBar`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
x, y = event.GetX(), event.GetY()
hovered_page = -1
refresh_tabs = False
if y < self._tab_height:
# It is quite likely that the mouse moved a small amount and is still over the same tab
if self._current_hovered_page != -1 and self._pages[self._current_hovered_page].rect.Contains((x, y)):
hovered_page = self._current_hovered_page
# But be careful, if tabs can be scrolled, then parts of the tab rect may not be valid
if self._tab_scroll_buttons_shown:
if x >= self._tab_scroll_right_button_rect.GetX() or x < self._tab_scroll_left_button_rect.GetRight():
hovered_page = -1
else:
hovered_page, dummy = self.HitTestTabs(event.GetPosition())
if hovered_page != self._current_hovered_page:
if self._current_hovered_page != -1:
self._pages[self._current_hovered_page].hovered = False
self._current_hovered_page = hovered_page
if self._current_hovered_page != -1:
self._pages[self._current_hovered_page].hovered = True
refresh_tabs = True
if self._tab_scroll_buttons_shown:
if self._tab_scroll_left_button_rect.Contains((x, y)):
self._tab_scroll_left_button_state, refresh_tabs = SET_FLAG(self._tab_scroll_left_button_state, RIBBON_SCROLL_BTN_HOVERED)
else:
self._tab_scroll_left_button_state, refresh_tabs = UNSET_FLAG(self._tab_scroll_left_button_state, RIBBON_SCROLL_BTN_HOVERED)
if self._tab_scroll_right_button_rect.Contains((x, y)):
self._tab_scroll_right_button_state, refresh_tabs = SET_FLAG(self._tab_scroll_right_button_state, RIBBON_SCROLL_BTN_HOVERED)
else:
self._tab_scroll_right_button_state, refresh_tabs = UNSET_FLAG(self._tab_scroll_right_button_state, RIBBON_SCROLL_BTN_HOVERED)
if refresh_tabs:
self.RefreshTabBar()
def OnMouseLeave(self, event):
"""
Handles the ``wx.EVT_LEAVE_WINDOW`` event for :class:`RibbonBar`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
# The ribbon bar is (usually) at the top of a window, and at least on MSW, the mouse
# can leave the window quickly and leave a tab in the hovered state.
refresh_tabs = False
if self._current_hovered_page != -1:
self._pages[self._current_hovered_page].hovered = False
self._current_hovered_page = -1
refresh_tabs = True
if self._tab_scroll_left_button_state & RIBBON_SCROLL_BTN_HOVERED:
self._tab_scroll_left_button_state &= ~RIBBON_SCROLL_BTN_HOVERED
refresh_tabs = True
if self._tab_scroll_right_button_state & RIBBON_SCROLL_BTN_HOVERED:
self._tab_scroll_right_button_state &= ~RIBBON_SCROLL_BTN_HOVERED
refresh_tabs = True
if refresh_tabs:
self.RefreshTabBar()
def GetPage(self, n):
"""
Get a page by index.
``None`` will be returned if the given index is out of range.
:param integer `n`: the zero-based index indicating the page position.
"""
if n < 0 or n >= len(self._pages):
return 0
return self._pages[n].page
def SetActivePageByIndex(self, page):
"""
Set the active page by index, without triggering any events.
:param integer `page`: The zero-based index of the page to activate.
:returns: ``True`` if the specified page is now active, ``False`` if it could
not be activated (for example because the page index is invalid).
"""
if self._current_page == page:
return True
if page >= len(self._pages):
return False
if self._current_page != -1:
self._pages[self._current_page].active = False
self._pages[self._current_page].page.Hide()
self._current_page = page
self._pages[page].active = True
wnd = self._pages[page].page
self.RepositionPage(wnd)
wnd.Layout()
wnd.Show()
self.Refresh()
return True
def SetActivePageByPage(self, page):
"""
Set the active page, without triggering any events.
:param `page`: the page to activate, an instance of :class:`~lib.agw.ribbon.page.RibbonPage`.
:returns: ``True`` if the specified page is now active, ``False`` if it could
not be activated (for example because the given page is not a child of the
ribbon bar).
"""
for i in range(len(self._pages)):
if self._pages[i].page == page:
return self.SetActivePageByIndex(i)
return False
def SetActivePage(self, page):
""" See comments on :meth:`~RibbonBar.SetActivePageByIndex` and :meth:`~RibbonBar.SetActivePageByPage`. """
if isinstance(page, six.integer_types):
return self.SetActivePageByIndex(page)
return self.SetActivePageByPage(page)
def GetActivePage(self):
"""
Get the index of the active page.
In the rare case of no page being active, -1 is returned.
"""
return self._current_page
def SetTabCtrlMargins(self, left, right):
"""
Set the margin widths (in pixels) on the left and right sides of the tab bar
region of the ribbon bar.
These margins will be painted with the tab background, but tabs and scroll
buttons will never be painted in the margins. The left margin could be used for
rendering something equivalent to the "Office Button", though this is not
currently implemented. The right margin could be used for rendering a help
button, and/or MDI buttons, but again, this is not currently implemented.
:param integer `left`: the left margin (in pixels);
:param integer `right`: the right margin (in pixels).
"""
self._tab_margin_left = left
self._tab_margin_right = right
self.RecalculateTabSizes()
def OrderPageTabInfoBySmallWidthAsc(self, first, second):
return first.small_must_have_separator_width - second.small_must_have_separator_width
def RecalculateTabSizes(self):
""" Recalculates the :class:`RibbonBar` tab sizes. """
numtabs = len(self._pages)
if numtabs == 0:
return
width = self.GetSize().GetWidth() - self._tab_margin_left - self._tab_margin_right
tabsep = self._art.GetMetric(RIBBON_ART_TAB_SEPARATION_SIZE)
x = self._tab_margin_left
y = 0
if width >= self._tabs_total_width_ideal:
# Simple case: everything at ideal width
for info in self._pages:
info.rect.x = x
info.rect.y = y
info.rect.width = info.ideal_width
info.rect.height = self._tab_height
x += info.rect.width + tabsep
self._tab_scroll_buttons_shown = False
self._tab_scroll_left_button_rect.SetWidth(0)
self._tab_scroll_right_button_rect.SetWidth(0)
elif width < self._tabs_total_width_minimum:
# Simple case: everything minimum with scrollbar
for info in self._pages:
info.rect.x = x
info.rect.y = y
info.rect.width = info.minimum_width
info.rect.height = self._tab_height
x += info.rect.width + tabsep
if not self._tab_scroll_buttons_shown:
self._tab_scroll_left_button_state = RIBBON_SCROLL_BTN_NORMAL
self._tab_scroll_right_button_state = RIBBON_SCROLL_BTN_NORMAL
self._tab_scroll_buttons_shown = True
temp_dc = wx.ClientDC(self)
self._tab_scroll_left_button_rect.SetWidth(self._art.GetScrollButtonMinimumSize(temp_dc, self,
RIBBON_SCROLL_BTN_LEFT | RIBBON_SCROLL_BTN_NORMAL |
RIBBON_SCROLL_BTN_FOR_TABS).GetWidth())
self._tab_scroll_left_button_rect.SetHeight(self._tab_height)
self._tab_scroll_left_button_rect.SetX(self._tab_margin_left)
self._tab_scroll_left_button_rect.SetY(0)
self._tab_scroll_right_button_rect.SetWidth(self._art.GetScrollButtonMinimumSize(temp_dc, self,
RIBBON_SCROLL_BTN_RIGHT | RIBBON_SCROLL_BTN_NORMAL |
RIBBON_SCROLL_BTN_FOR_TABS).GetWidth())
self._tab_scroll_right_button_rect.SetHeight(self._tab_height)
self._tab_scroll_right_button_rect.SetX(self.GetClientSize().GetWidth() - self._tab_margin_right - self._tab_scroll_right_button_rect.GetWidth())
self._tab_scroll_right_button_rect.SetY(0)
if self._tab_scroll_amount == 0:
self._tab_scroll_left_button_rect.SetWidth(0)
elif self._tab_scroll_amount + width >= self._tabs_total_width_minimum:
self._tab_scroll_amount = self._tabs_total_width_minimum - width
self._tab_scroll_right_button_rect.SetX(self._tab_scroll_right_button_rect.GetX() + self._tab_scroll_right_button_rect.GetWidth())
self._tab_scroll_right_button_rect.SetWidth(0)
for info in self._pages:
info.rect.x -= self._tab_scroll_amount
else:
self._tab_scroll_buttons_shown = False
self._tab_scroll_left_button_rect.SetWidth(0)
self._tab_scroll_right_button_rect.SetWidth(0)
# Complex case: everything sized such that: minimum <= width < ideal
#
# Strategy:
# 1) Uniformly reduce all tab widths from ideal to small_must_have_separator_width
# 2) Reduce the largest tab by 1 pixel, repeating until all tabs are same width (or at minimum)
# 3) Uniformly reduce all tabs down to their minimum width
#
smallest_tab_width = 10000
total_small_width = tabsep * (numtabs - 1)
for info in self._pages:
if info.small_must_have_separator_width < smallest_tab_width:
smallest_tab_width = info.small_must_have_separator_width
total_small_width += info.small_must_have_separator_width
if width >= total_small_width:
# Do (1)
total_delta = self._tabs_total_width_ideal - total_small_width
total_small_width -= tabsep*(numtabs - 1)
width -= tabsep*(numtabs - 1)
for info in self._pages:
delta = info.ideal_width - info.small_must_have_separator_width
info.rect.x = x
info.rect.y = y
info.rect.width = info.small_must_have_separator_width + delta*(width - total_small_width)/total_delta
info.rect.height = self._tab_height
x += info.rect.width + tabsep
total_delta -= delta
total_small_width -= info.small_must_have_separator_width
width -= info.rect.width
else:
total_small_width = tabsep*(numtabs - 1)
for info in self._pages:
if info.minimum_width < smallest_tab_width:
total_small_width += smallest_tab_width
else:
total_small_width += info.minimum_width
if width >= total_small_width:
# Do (2)
sorted_pages = []
for info in self._pages:
# Sneaky obj array trickery to not copy the tab descriptors
sorted_pages.append(info)
sorted_pages.sort(self.OrderPageTabInfoBySmallWidthAsc)
width -= tabsep*(numtabs - 1)
for i, info in enumerate(self._pages):
if info.small_must_have_separator_width*(numtabs - i) <= width:
info.rect.width = info.small_must_have_separator_width
else:
info.rect.width = width/(numtabs - i)
width -= info.rect.width
for i, info in enumerate(self._pages):
info.rect.x = x
info.rect.y = y
info.rect.height = self._tab_height
x += info.rect.width + tabsep
sorted_pages.pop(numtabs - (i + 1))
else:
# Do (3)
total_small_width = (smallest_tab_width + tabsep)*numtabs - tabsep
total_delta = total_small_width - self._tabs_total_width_minimum
total_small_width = self._tabs_total_width_minimum - tabsep*(numtabs - 1)
width -= tabsep*(numtabs - 1)
for info in self._pages:
delta = smallest_tab_width - info.minimum_width
info.rect.x = x
info.rect.y = y
info.rect.width = info.minimum_width + delta*(width - total_small_width)/total_delta
info.rect.height = self._tab_height
x += info.rect.width + tabsep
total_delta -= delta
total_small_width -= info.minimum_width
width -= info.rect.width
def CommonInit(self, agwStyle):
"""
Common initialization procedures.
:param integer `agwStyle`: the AGW-specific window style.
:see: :meth:`~RibbonBar.SetAGWWindowStyleFlag` for a list of valid window styles.
"""
self.SetName("RibbonBar")
self._flags = agwStyle
self._tabs_total_width_ideal = 0
self._tabs_total_width_minimum = 0
self._tab_margin_left = 50
self._tab_margin_right = 20
self._tab_height = 20 # initial guess
self._tab_scroll_amount = 0
self._current_page = -1
self._current_hovered_page = -1
self._tab_scroll_left_button_state = RIBBON_SCROLL_BTN_NORMAL
self._tab_scroll_right_button_state = RIBBON_SCROLL_BTN_NORMAL
self._tab_scroll_buttons_shown = False
self._arePanelsShown = True
self._tab_scroll_left_button_rect = wx.Rect()
self._tab_scroll_right_button_rect = wx.Rect()
if not self._art:
self.SetArtProvider(RibbonMSWArtProvider())
self.SetBackgroundStyle(wx.BG_STYLE_CUSTOM)
def SetArtProvider(self, art):
"""
Set the art provider to be used be the ribbon bar.
Also sets the art provider on all current :class:`~lib.agw.ribbon.page.RibbonPage` children, and any
:class:`~lib.agw.ribbon.page.RibbonPage` children added in the future.
Note that unlike most other ribbon controls, the ribbon bar creates a default
art provider when initialised, so an explicit call to :meth:`~RibbonBar.SetArtProvider` is
not required if the default art provider is sufficient. Also unlike other
ribbon controls, the ribbon bar takes ownership of the given pointer, and
will delete it when the art provider is changed or the bar is destroyed.
If this behaviour is not desired, then clone the art provider before setting
it.
:param `art`: an art provider.
:note: Reimplemented from :class:`~lib.agw.ribbon.control.RibbonControl`.
"""
self._art = art
if art:
art.SetFlags(self._flags)
for info in self._pages:
if info.page.GetArtProvider() != art:
info.page.SetArtProvider(art)
def OnPaint(self, event):
"""
Handles the ``wx.EVT_PAINT`` event for :class:`RibbonBar`.
:param `event`: a :class:`PaintEvent` event to be processed.
"""
dc = wx.AutoBufferedPaintDC(self)
if not self.GetUpdateRegion().Contains(wx.Rect(0, 0, self.GetClientSize().GetWidth(), self._tab_height)):
# Nothing to do in the tab area, and the page area is handled by the active page
return
self.DoEraseBackground(dc)
numtabs = len(self._pages)
sep_visibility = 0.0
draw_sep = False
tabs_rect = wx.Rect(self._tab_margin_left, 0, self.GetClientSize().GetWidth() - self._tab_margin_left - self._tab_margin_right, self._tab_height)
if self._tab_scroll_buttons_shown:
tabs_rect.x += self._tab_scroll_left_button_rect.GetWidth()
tabs_rect.width -= self._tab_scroll_left_button_rect.GetWidth() + self._tab_scroll_right_button_rect.GetWidth()
for info in self._pages:
dc.DestroyClippingRegion()
if self._tab_scroll_buttons_shown:
if not tabs_rect.Intersects(info.rect):
continue
dc.SetClippingRegion(tabs_rect)
dc.SetClippingRegion(info.rect)
self._art.DrawTab(dc, self, info)
if info.rect.width < info.small_begin_need_separator_width:
draw_sep = True
if info.rect.width < info.small_must_have_separator_width:
sep_visibility += 1.0
else:
sep_visibility += float(info.small_begin_need_separator_width - info.rect.width)/ \
float(info.small_begin_need_separator_width - info.small_must_have_separator_width)
if draw_sep:
rect = wx.Rect(*self._pages[0].rect)
rect.width = self._art.GetMetric(RIBBON_ART_TAB_SEPARATION_SIZE)
sep_visibility /= float(numtabs)
for i in range(0, numtabs-1):
info = self._pages[i]
rect.x = info.rect.x + info.rect.width
if self._tab_scroll_buttons_shown and not tabs_rect.Intersects(rect):
continue
dc.DestroyClippingRegion()
dc.SetClippingRegion(rect)
self._art.DrawTabSeparator(dc, self, rect, sep_visibility)
if self._tab_scroll_buttons_shown:
dc.DestroyClippingRegion()
if self._tab_scroll_left_button_rect.GetWidth() != 0:
self._art.DrawScrollButton(dc, self, self._tab_scroll_left_button_rect, RIBBON_SCROLL_BTN_LEFT |
self._tab_scroll_left_button_state | RIBBON_SCROLL_BTN_FOR_TABS)
if self._tab_scroll_right_button_rect.GetWidth() != 0:
self._art.DrawScrollButton(dc, self, self._tab_scroll_right_button_rect, RIBBON_SCROLL_BTN_RIGHT |
self._tab_scroll_right_button_state | RIBBON_SCROLL_BTN_FOR_TABS)
def OnEraseBackground(self, event):
"""
Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`RibbonBar`.
:param `event`: a :class:`EraseEvent` event to be processed.
"""
# Background painting done in main paint handler to reduce screen flicker
pass
def DoEraseBackground(self, dc):
"""
Does the initial painting of stuff from the :meth:`~RibbonBar.OnPaint` event.
:param `dc`: an instance of :class:`DC`.
"""
tabs = wx.Rect(0, 0, *self.GetSize())
tabs.height = self._tab_height
self._art.DrawTabCtrlBackground(dc, self, tabs)
def OnSize(self, event):
"""
Handles the ``wx.EVT_SIZE`` event for :class:`RibbonBar`.
:param `event`: a :class:`SizeEvent` event to be processed.
"""
self.RecalculateTabSizes()
if self._current_page != -1:
self.RepositionPage(self._pages[self._current_page].page)
self.RefreshTabBar()
event.Skip()
def RepositionPage(self, page):
w, h = self.GetSize()
page.SetSizeWithScrollButtonAdjustment(0, self._tab_height, w, h - self._tab_height)
def HitTestTabs(self, position):
"""
Hit test method for :class:`RibbonBar`, testing where the given (in client coordinates)
point lies.
:param `position`: an instance of :class:`Point` in client coordinates.
:return: a tuple containing the tab index and the :class:`~lib.agw.ribbon.page.RibbonPage` if the :meth:`~RibbonBar.HitTestTabs`
successfully found such combination, or a tuple `(-1, None)` if no tab has been hit.
"""
tabs_rect = wx.Rect(self._tab_margin_left, 0, self.GetClientSize().GetWidth() - self._tab_margin_left - self._tab_margin_right, self._tab_height)
if self._tab_scroll_buttons_shown:
tabs_rect.SetX(tabs_rect.GetX() + self._tab_scroll_left_button_rect.GetWidth())
tabs_rect.SetWidth(tabs_rect.GetWidth() - self._tab_scroll_left_button_rect.GetWidth() - self._tab_scroll_right_button_rect.GetWidth())
if tabs_rect.Contains(position):
for i, info in enumerate(self._pages):
if info.rect.Contains(position):
return i, info
return -1, None
def OnMouseLeftDown(self, event):
"""
Handles the ``wx.EVT_LEFT_DOWN`` event for :class:`RibbonBar`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
index, tab = self.HitTestTabs(event.GetPosition())
if tab and tab != self._pages[self._current_page]:
query = RibbonBarEvent(wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGING, self.GetId(), tab.page)
query.SetEventObject(self)
self.GetEventHandler().ProcessEvent(query)
if query.IsAllowed():
self.SetActivePage(query.GetPage())
notification = RibbonBarEvent(wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGED, self.GetId(), self._pages[self._current_page].page)
notification.SetEventObject(self)
self.GetEventHandler().ProcessEvent(notification)
elif tab == None:
if self._tab_scroll_left_button_rect.Contains(event.GetPosition()):
self._tab_scroll_left_button_state |= RIBBON_SCROLL_BTN_ACTIVE | RIBBON_SCROLL_BTN_HOVERED
self.RefreshTabBar()
elif self._tab_scroll_right_button_rect.Contains(event.GetPosition()):
self._tab_scroll_right_button_state |= RIBBON_SCROLL_BTN_ACTIVE | RIBBON_SCROLL_BTN_HOVERED
self.RefreshTabBar()
def OnMouseDoubleClick(self, event):
"""
Handles the ``wx.EVT_LEFT_DCLICK`` event for :class:`RibbonBar`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
self.DoMouseButtonCommon(event, wxEVT_COMMAND_RIBBONBAR_TAB_LEFT_DCLICK)
def OnMouseLeftUp(self, event):
"""
Handles the ``wx.EVT_LEFT_UP`` event for :class:`RibbonBar`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
if not self._tab_scroll_buttons_shown:
return
amount = 0
if self._tab_scroll_left_button_state & RIBBON_SCROLL_BTN_ACTIVE:
amount = -1
elif self._tab_scroll_right_button_state & RIBBON_SCROLL_BTN_ACTIVE:
amount = 1
if amount != 0:
self._tab_scroll_left_button_state &= ~RIBBON_SCROLL_BTN_ACTIVE
self._tab_scroll_right_button_state &= ~RIBBON_SCROLL_BTN_ACTIVE
self.ScrollTabBar(amount*8)
def ScrollTabBar(self, amount):
"""
Scrolls the tab area left/right/up/down by the specified `amount`.
:param integer `amount`: the amount by which the tab area is scrolled, in pixels.
"""
show_left = True
show_right = True
if self._tab_scroll_amount + amount <= 0:
amount = -self._tab_scroll_amount
show_left = False
elif self._tab_scroll_amount + amount + (self.GetClientSize().GetWidth() - \
self._tab_margin_left - self._tab_margin_right) >= \
self._tabs_total_width_minimum:
amount = self._tabs_total_width_minimum - self._tab_scroll_amount - \
(self.GetClientSize().GetWidth() - self._tab_margin_left - self._tab_margin_right)
show_right = False
if amount == 0:
return
self._tab_scroll_amount += amount
for info in self._pages:
info.rect.SetX(info.rect.GetX() - amount)
if show_right != (self._tab_scroll_right_button_rect.GetWidth() != 0) or \
show_left != (self._tab_scroll_left_button_rect.GetWidth() != 0):
temp_dc = wx.ClientDC(self)
if show_left:
self._tab_scroll_left_button_rect.SetWidth(self._art.GetScrollButtonMinimumSize(temp_dc, self, RIBBON_SCROLL_BTN_LEFT |
RIBBON_SCROLL_BTN_NORMAL |
RIBBON_SCROLL_BTN_FOR_TABS).GetWidth())
else:
self._tab_scroll_left_button_rect.SetWidth(0)
if show_right:
if self._tab_scroll_right_button_rect.GetWidth() == 0:
self._tab_scroll_right_button_rect.SetWidth(self._art.GetScrollButtonMinimumSize(temp_dc, self,
RIBBON_SCROLL_BTN_RIGHT |
RIBBON_SCROLL_BTN_NORMAL |
RIBBON_SCROLL_BTN_FOR_TABS).GetWidth())
self._tab_scroll_right_button_rect.SetX(self._tab_scroll_right_button_rect.GetX() - self._tab_scroll_right_button_rect.GetWidth())
else:
if self._tab_scroll_right_button_rect.GetWidth() != 0:
self._tab_scroll_right_button_rect.SetX(self._tab_scroll_right_button_rect.GetX() + self._tab_scroll_right_button_rect.GetWidth())
self._tab_scroll_right_button_rect.SetWidth(0)
self.RefreshTabBar()
def RefreshTabBar(self):
""" Repaints the tab area in :class:`RibbonBar`. """
tab_rect = wx.Rect(0, 0, self.GetClientSize().GetWidth(), self._tab_height)
self.Refresh(False, tab_rect)
def OnMouseMiddleDown(self, event):
"""
Handles the ``wx.EVT_MIDDLE_DOWN`` event for :class:`RibbonBar`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
self.DoMouseButtonCommon(event, wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_DOWN)
def OnMouseMiddleUp(self, event):
"""
Handles the ``wx.EVT_MIDDLE_UP`` event for :class:`RibbonBar`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
self.DoMouseButtonCommon(event, wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_UP)
def OnMouseRightDown(self, event):
"""
Handles the ``wx.EVT_RIGHT_DOWN`` event for :class:`RibbonBar`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
self.DoMouseButtonCommon(event, wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_DOWN)
def OnMouseRightUp(self, event):
"""
Handles the ``wx.EVT_RIGHT_UP`` event for :class:`RibbonBar`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
self.DoMouseButtonCommon(event, wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_UP)
def DoMouseButtonCommon(self, event, tab_event_type):
"""
Common methods for all the mouse move/click events.
:param `event`: a :class:`MouseEvent` event to be processed;
:param integer `tab_event_type`: one of the :class:`RibbonBar` events.
"""
index, tab = self.HitTestTabs(event.GetPosition())
if tab:
notification = RibbonBarEvent(tab_event_type, self.GetId(), tab.page)
notification.SetEventObject(self)
self.GetEventHandler().ProcessEvent(notification)
def RecalculateMinSize(self):
""" Recalculates the :class:`RibbonBar` minimum size. """
min_size = wx.Size(-1, -1)
numtabs = len(self._pages)
if numtabs != 0:
min_size = wx.Size(*self._pages[0].page.GetMinSize())
for info in self._pages:
page_min = info.page.GetMinSize()
min_size.x = max(min_size.x, page_min.x)
min_size.y = max(min_size.y, page_min.y)
if min_size.y != -1:
# TODO: Decide on best course of action when min height is unspecified
# - should we specify it to the tab minimum, or leave it unspecified?
min_size.IncBy(0, self._tab_height)
self._minWidth = min_size.GetWidth()
self._minHeight = (self._arePanelsShown and [min_size.GetHeight()] or [self._tab_height])[0]
def DoGetBestSize(self):
"""
Gets the size which best suits the window: for a control, it would be the
minimal size which doesn't truncate the control, for a panel - the same size
as it would have after a call to `Fit()`.
:return: An instance of :class:`Size`.
:note: Overridden from :class:`Control`.
"""
best = wx.Size(0, 0)
if self._current_page != -1:
best = wx.Size(*self._pages[self._current_page].page.GetBestSize())
if best.GetHeight() == -1:
best.SetHeight(self._tab_height)
else:
best.IncBy(0, self._tab_height)
if not self._arePanelsShown:
best.SetHeight(self._tab_height)
return best
def HasMultiplePages(self):
"""
This method should be overridden to return true if this window has multiple pages.
All standard class with multiple pages such as :class:`Notebook`, :class:`Listbook` and :class:`Treebook`
already override it to return true and user-defined classes with similar behaviour should also
do so, to allow the library to handle such windows appropriately.
"""
return True
def GetDefaultBorder(self):
""" Returns the default border style for :class:`RibbonBar`. """
return wx.BORDER_NONE
Reference in a new issue View git blame Copy permalink