// Author: Peter Cawley
// Modified by:
// Created: 2009-05-23
-// RCS-ID: $Id$
// Copyright: (C) Peter Cawley
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#include "wx/ribbon/art.h"
#include "wx/dcbuffer.h"
#include "wx/app.h"
+#include "wx/vector.h"
#ifndef WX_PRECOMP
#endif
WX_DEFINE_USER_EXPORTED_OBJARRAY(wxRibbonPageTabInfoArray)
-wxDEFINE_EVENT(wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGED, wxRibbonBarEvent);
-wxDEFINE_EVENT(wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGING, wxRibbonBarEvent);
-wxDEFINE_EVENT(wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_DOWN, wxRibbonBarEvent);
-wxDEFINE_EVENT(wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_UP, wxRibbonBarEvent);
-wxDEFINE_EVENT(wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_DOWN, wxRibbonBarEvent);
-wxDEFINE_EVENT(wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_UP, wxRibbonBarEvent);
-wxDEFINE_EVENT(wxEVT_COMMAND_RIBBONBAR_TAB_LEFT_DCLICK, wxRibbonBarEvent);
-wxDEFINE_EVENT(wxEVT_COMMAND_RIBBONBAR_TOGGLED, wxRibbonBarEvent);
+wxDEFINE_EVENT(wxEVT_RIBBONBAR_PAGE_CHANGED, wxRibbonBarEvent);
+wxDEFINE_EVENT(wxEVT_RIBBONBAR_PAGE_CHANGING, wxRibbonBarEvent);
+wxDEFINE_EVENT(wxEVT_RIBBONBAR_TAB_MIDDLE_DOWN, wxRibbonBarEvent);
+wxDEFINE_EVENT(wxEVT_RIBBONBAR_TAB_MIDDLE_UP, wxRibbonBarEvent);
+wxDEFINE_EVENT(wxEVT_RIBBONBAR_TAB_RIGHT_DOWN, wxRibbonBarEvent);
+wxDEFINE_EVENT(wxEVT_RIBBONBAR_TAB_RIGHT_UP, wxRibbonBarEvent);
+wxDEFINE_EVENT(wxEVT_RIBBONBAR_TAB_LEFT_DCLICK, wxRibbonBarEvent);
+wxDEFINE_EVENT(wxEVT_RIBBONBAR_TOGGLED, wxRibbonBarEvent);
+wxDEFINE_EVENT(wxEVT_RIBBONBAR_HELP_CLICK, wxRibbonBarEvent);
IMPLEMENT_CLASS(wxRibbonBar, wxRibbonControl)
IMPLEMENT_DYNAMIC_CLASS(wxRibbonBarEvent, wxNotifyEvent)
EVT_RIGHT_UP(wxRibbonBar::OnMouseRightUp)
EVT_LEFT_DCLICK(wxRibbonBar::OnMouseDoubleClick)
EVT_SIZE(wxRibbonBar::OnSize)
+ EVT_KILL_FOCUS(wxRibbonBar::OnKillFocus)
END_EVENT_TABLE()
void wxRibbonBar::AddPage(wxRibbonPage *page)
info.page = page;
info.active = false;
info.hovered = false;
+ info.highlight = false;
info.shown = true;
// info.rect not set (intentional)
{
RefreshTabBar();
}
- HitTestToggleButton(evt.GetPosition());
+ if ( m_flags & wxRIBBON_BAR_SHOW_TOGGLE_BUTTON )
+ HitTestRibbonButton(m_toggle_button_rect, evt.GetPosition(), m_toggle_button_hovered);
+ if ( m_flags & wxRIBBON_BAR_SHOW_HELP_BUTTON )
+ HitTestRibbonButton(m_help_button_rect, evt.GetPosition(), m_help_button_hovered);
}
void wxRibbonBar::OnMouseLeave(wxMouseEvent& WXUNUSED(evt))
m_toggle_button_hovered = false;
Refresh(false);
}
+ if ( m_help_button_hovered )
+ {
+ m_help_button_hovered = false;
+ m_bar_hovered = false;
+ Refresh(false);
+ }
}
wxRibbonPage* wxRibbonBar::GetPage(int n)
m_pages.Item(page).shown = show;
}
+bool wxRibbonBar::IsPageHighlighted(size_t page) const
+{
+ if (page >= m_pages.GetCount())
+ return false;
+ return m_pages.Item(page).highlight;
+}
+
+void wxRibbonBar::AddPageHighlight(size_t page, bool highlight)
+{
+ if(page >= m_pages.GetCount())
+ return;
+ m_pages.Item(page).highlight = highlight;
+}
+
void wxRibbonBar::DeletePage(size_t n)
{
if(n < m_pages.GetCount())
RecalculateTabSizes();
}
-static int OrderPageTabInfoBySmallWidthAsc(wxRibbonPageTabInfo **first, wxRibbonPageTabInfo **second)
+struct PageComparedBySmallWidthAsc
{
- return (**first).small_must_have_separator_width - (**second).small_must_have_separator_width;
-}
+ wxEXPLICIT PageComparedBySmallWidthAsc(wxRibbonPageTabInfo* page)
+ : m_page(page)
+ {
+ }
+
+ bool operator<(const PageComparedBySmallWidthAsc& other) const
+ {
+ return m_page->small_must_have_separator_width
+ < other.m_page->small_must_have_separator_width;
+ }
+
+ wxRibbonPageTabInfo *m_page;
+};
void wxRibbonBar::RecalculateTabSizes()
{
}
{
wxClientDC temp_dc(this);
+ int right_button_pos = GetClientSize().GetWidth() - m_tab_margin_right - m_tab_scroll_right_button_rect.GetWidth();
+ if ( right_button_pos < m_tab_margin_left )
+ right_button_pos = m_tab_margin_left;
+
m_tab_scroll_left_button_rect.SetWidth(m_art->GetScrollButtonMinimumSize(temp_dc, this, wxRIBBON_SCROLL_BTN_LEFT | wxRIBBON_SCROLL_BTN_NORMAL | wxRIBBON_SCROLL_BTN_FOR_TABS).GetWidth());
m_tab_scroll_left_button_rect.SetHeight(m_tab_height);
m_tab_scroll_left_button_rect.SetX(m_tab_margin_left);
m_tab_scroll_left_button_rect.SetY(0);
m_tab_scroll_right_button_rect.SetWidth(m_art->GetScrollButtonMinimumSize(temp_dc, this, wxRIBBON_SCROLL_BTN_RIGHT | wxRIBBON_SCROLL_BTN_NORMAL | wxRIBBON_SCROLL_BTN_FOR_TABS).GetWidth());
m_tab_scroll_right_button_rect.SetHeight(m_tab_height);
- m_tab_scroll_right_button_rect.SetX(GetClientSize().GetWidth() - m_tab_margin_right - m_tab_scroll_right_button_rect.GetWidth());
+ m_tab_scroll_right_button_rect.SetX(right_button_pos);
m_tab_scroll_right_button_rect.SetY(0);
}
if(m_tab_scroll_amount == 0)
if(width >= total_small_width)
{
// Do (2)
- wxRibbonPageTabInfoArray sorted_pages;
- for(i = 0; i < numtabs; ++i)
- {
- // Sneaky obj array trickery to not copy the tab descriptors
- if (!m_pages.Item(i).shown)
- continue;
- sorted_pages.Add(&m_pages.Item(i));
- }
- sorted_pages.Sort(OrderPageTabInfoBySmallWidthAsc);
+ wxVector<PageComparedBySmallWidthAsc> sorted_pages;
+ sorted_pages.reserve(numtabs);
+ for ( i = 0; i < numtabs; ++i )
+ sorted_pages.push_back(PageComparedBySmallWidthAsc(&m_pages.Item(i)));
+
+ wxVectorSort(sorted_pages);
width -= tabsep * (numtabs - 1);
for(i = 0; i < numtabs; ++i)
{
- wxRibbonPageTabInfo& info = sorted_pages.Item(i);
- if (!info.shown)
+ wxRibbonPageTabInfo* info = sorted_pages[i].m_page;
+ if (!info->shown)
continue;
- if(info.small_must_have_separator_width * (int)(numtabs - i) <= width)
+ if(info->small_must_have_separator_width * (int)(numtabs - i) <= width)
{
- info.rect.width = info.small_must_have_separator_width;;
+ info->rect.width = info->small_must_have_separator_width;;
}
else
{
- info.rect.width = width / (numtabs - i);
+ info->rect.width = width / (numtabs - i);
}
- width -= info.rect.width;
+ width -= info->rect.width;
}
for(i = 0; i < numtabs; ++i)
{
info.rect.y = y;
info.rect.height = m_tab_height;
x += info.rect.width + tabsep;
- sorted_pages.Detach(numtabs - (i + 1));
}
}
else
m_tab_scroll_right_button_state = wxRIBBON_SCROLL_BTN_NORMAL;
m_tab_scroll_buttons_shown = false;
m_arePanelsShown = true;
+ m_help_button_hovered = false;
}
wxRibbonBar::wxRibbonBar(wxWindow* parent,
m_tabs_total_width_minimum = 0;
m_tab_margin_left = 50;
m_tab_margin_right = 20;
+ if ( m_flags & wxRIBBON_BAR_SHOW_TOGGLE_BUTTON )
+ m_tab_margin_right += 20;
+ if ( m_flags & wxRIBBON_BAR_SHOW_HELP_BUTTON )
+ m_tab_margin_right += 20;
m_tab_height = 20; // initial guess
m_tab_scroll_amount = 0;
m_current_page = -1;
m_toggle_button_hovered = false;
m_bar_hovered = false;
+
+ m_ribbon_state = wxRIBBON_BAR_PINNED;
}
void wxRibbonBar::SetArtProvider(wxRibbonArtProvider* art)
DoEraseBackground(dc);
- m_toggle_button_rect = m_art->GetBarToggleButtonArea(dc, this, GetSize());
+ if ( m_flags & wxRIBBON_BAR_SHOW_HELP_BUTTON )
+ m_help_button_rect = m_art->GetRibbonHelpButtonArea(GetSize());
+ if ( m_flags & wxRIBBON_BAR_SHOW_TOGGLE_BUTTON )
+ m_toggle_button_rect = m_art->GetBarToggleButtonArea(GetSize());
size_t numtabs = m_pages.GetCount();
double sep_visibility = 0.0;
}
if(m_tab_scroll_buttons_shown)
{
- dc.DestroyClippingRegion();
if(m_tab_scroll_left_button_rect.GetWidth() != 0)
{
+ dc.DestroyClippingRegion();
+ dc.SetClippingRegion(m_tab_scroll_left_button_rect);
m_art->DrawScrollButton(dc, this, m_tab_scroll_left_button_rect, wxRIBBON_SCROLL_BTN_LEFT | m_tab_scroll_left_button_state | wxRIBBON_SCROLL_BTN_FOR_TABS);
}
if(m_tab_scroll_right_button_rect.GetWidth() != 0)
{
+ dc.DestroyClippingRegion();
+ dc.SetClippingRegion(m_tab_scroll_right_button_rect);
m_art->DrawScrollButton(dc, this, m_tab_scroll_right_button_rect, wxRIBBON_SCROLL_BTN_RIGHT | m_tab_scroll_right_button_state | wxRIBBON_SCROLL_BTN_FOR_TABS);
}
}
- wxRect rect(GetClientSize().GetWidth() - 30, 6, 12, 12);
+
+ if ( m_flags & wxRIBBON_BAR_SHOW_HELP_BUTTON )
+ m_art->DrawHelpButton(dc, this, m_help_button_rect);
if ( m_flags & wxRIBBON_BAR_SHOW_TOGGLE_BUTTON )
- m_art->DrawToggleButton(dc, this, rect, ArePanelsShown());
+ m_art->DrawToggleButton(dc, this, m_toggle_button_rect, m_ribbon_state);
+
}
void wxRibbonBar::OnEraseBackground(wxEraseEvent& WXUNUSED(evt))
void wxRibbonBar::OnMouseLeftDown(wxMouseEvent& evt)
{
wxRibbonPageTabInfo *tab = HitTestTabs(evt.GetPosition());
+ SetFocus();
+ if ( tab )
+ {
+ if ( m_ribbon_state == wxRIBBON_BAR_MINIMIZED )
+ {
+ ShowPanels();
+ m_ribbon_state = wxRIBBON_BAR_EXPANDED;
+ }
+ else if ( (tab == &m_pages.Item(m_current_page)) && (m_ribbon_state == wxRIBBON_BAR_EXPANDED) )
+ {
+ HidePanels();
+ m_ribbon_state = wxRIBBON_BAR_MINIMIZED;
+ }
+ }
+ else
+ {
+ if ( m_ribbon_state == wxRIBBON_BAR_EXPANDED )
+ {
+ HidePanels();
+ m_ribbon_state = wxRIBBON_BAR_MINIMIZED;
+ }
+ }
if(tab && tab != &m_pages.Item(m_current_page))
{
- wxRibbonBarEvent query(wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGING, GetId(), tab->page);
+ wxRibbonBarEvent query(wxEVT_RIBBONBAR_PAGE_CHANGING, GetId(), tab->page);
query.SetEventObject(this);
ProcessWindowEvent(query);
if(query.IsAllowed())
{
SetActivePage(query.GetPage());
- wxRibbonBarEvent notification(wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGED, GetId(), m_pages.Item(m_current_page).page);
+ wxRibbonBarEvent notification(wxEVT_RIBBONBAR_PAGE_CHANGED, GetId(), m_pages.Item(m_current_page).page);
notification.SetEventObject(this);
ProcessWindowEvent(notification);
}
{
if(m_toggle_button_rect.Contains(position))
{
- ShowPanels(!ArePanelsShown());
- wxRibbonBarEvent event(wxEVT_COMMAND_RIBBONBAR_TOGGLED, GetId());
+ bool pshown = ArePanelsShown();
+ ShowPanels(!pshown);
+ if ( pshown )
+ m_ribbon_state = wxRIBBON_BAR_MINIMIZED;
+ else
+ m_ribbon_state = wxRIBBON_BAR_PINNED;
+ wxRibbonBarEvent event(wxEVT_RIBBONBAR_TOGGLED, GetId());
+ event.SetEventObject(this);
+ ProcessWindowEvent(event);
+ }
+ if ( m_help_button_rect.Contains(position) )
+ {
+ wxRibbonBarEvent event(wxEVT_RIBBONBAR_HELP_CLICK, GetId());
event.SetEventObject(this);
ProcessWindowEvent(event);
}
void wxRibbonBar::OnMouseMiddleDown(wxMouseEvent& evt)
{
- DoMouseButtonCommon(evt, wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_DOWN);
+ DoMouseButtonCommon(evt, wxEVT_RIBBONBAR_TAB_MIDDLE_DOWN);
}
void wxRibbonBar::OnMouseMiddleUp(wxMouseEvent& evt)
{
- DoMouseButtonCommon(evt, wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_UP);
+ DoMouseButtonCommon(evt, wxEVT_RIBBONBAR_TAB_MIDDLE_UP);
}
void wxRibbonBar::OnMouseRightDown(wxMouseEvent& evt)
{
- DoMouseButtonCommon(evt, wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_DOWN);
+ DoMouseButtonCommon(evt, wxEVT_RIBBONBAR_TAB_RIGHT_DOWN);
}
void wxRibbonBar::OnMouseRightUp(wxMouseEvent& evt)
{
- DoMouseButtonCommon(evt, wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_UP);
+ DoMouseButtonCommon(evt, wxEVT_RIBBONBAR_TAB_RIGHT_UP);
}
void wxRibbonBar::OnMouseDoubleClick(wxMouseEvent& evt)
{
- DoMouseButtonCommon(evt, wxEVT_COMMAND_RIBBONBAR_TAB_LEFT_DCLICK);
+ wxRibbonPageTabInfo *tab = HitTestTabs(evt.GetPosition());
+ SetFocus();
+ if ( tab && tab == &m_pages.Item(m_current_page) )
+ {
+ if ( m_ribbon_state == wxRIBBON_BAR_PINNED )
+ {
+ m_ribbon_state = wxRIBBON_BAR_MINIMIZED;
+ HidePanels();
+ }
+ else
+ {
+ m_ribbon_state = wxRIBBON_BAR_PINNED;
+ ShowPanels();
+ }
+ }
}
void wxRibbonBar::DoMouseButtonCommon(wxMouseEvent& evt, wxEventType tab_event_type)
return best;
}
-void wxRibbonBar::HitTestToggleButton(wxPoint position)
+void wxRibbonBar::HitTestRibbonButton(const wxRect& rect, const wxPoint& position, bool &hover_flag)
{
bool hovered = false, toggle_button_hovered = false;
if(position.x >= 0 && position.y >= 0)
}
if(hovered)
{
- toggle_button_hovered = (m_flags & wxRIBBON_BAR_SHOW_TOGGLE_BUTTON) &&
- m_toggle_button_rect.Contains(position);
+ toggle_button_hovered = rect.Contains(position);
- if(hovered != m_bar_hovered || toggle_button_hovered != m_toggle_button_hovered)
+ if ( hovered != m_bar_hovered || toggle_button_hovered != hover_flag )
{
m_bar_hovered = hovered;
- m_toggle_button_hovered = toggle_button_hovered;
+ hover_flag = toggle_button_hovered;
Refresh(false);
}
}
}
+void wxRibbonBar::HideIfExpanded()
+{
+ if ( m_ribbon_state == wxRIBBON_BAR_EXPANDED )
+ {
+ HidePanels();
+ m_ribbon_state = wxRIBBON_BAR_MINIMIZED;
+ }
+ else
+ {
+ ShowPanels();
+ m_ribbon_state = wxRIBBON_BAR_PINNED;
+ }
+}
+
+void wxRibbonBar::OnKillFocus(wxFocusEvent& WXUNUSED(evt))
+{
+ HideIfExpanded();
+}
+
#endif // wxUSE_RIBBON