Notebook Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Notebook.hpp>

Inheritance diagram for Notebook:

Collaboration diagram for Notebook:

Public Member Functions
	Notebook (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, wxBoxSizer *side_tools=NULL, long style=0)
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, wxBoxSizer *side_tools=NULL, long style=0)
bool	ShowNewPage (wxWindow *page)
void	SetEffects (wxShowEffect showEffect, wxShowEffect hideEffect)
void	SetEffect (wxShowEffect effect)
void	SetEffectsTimeouts (unsigned showTimeout, unsigned hideTimeout)
void	SetEffectTimeout (unsigned timeout)
bool	AddPage (const wxString &id, wxWindow *page, const wxString &text, const std::string &bmp_name="", bool bSelect=false)
bool	AddPage (wxWindow *page, const wxString &text, bool bSelect=false, int imageId=NO_IMAGE) override
bool	InsertPage (size_t n, const wxString &id, wxWindow *page, const wxString &text, const std::string &bmp_name="", bool bSelect=false, const wxBitmap &bmp=wxNullBitmap)
virtual bool	InsertPage (size_t n, wxWindow *page, const wxString &text, bool bSelect=false, int WXUNUSED(imageId)=NO_IMAGE) override
virtual int	SetSelection (size_t n) override
virtual int	ChangeSelection (size_t n) override
virtual bool	SetPageText (size_t n, const wxString &strText) override
virtual wxString	GetPageText (size_t n) const override
wxString	GetPageLabel (size_t n) const
std::string	GetPageIcon (size_t n) const
virtual bool	SetPageImage (size_t WXUNUSED(n), int WXUNUSED(imageId)) override
virtual int	GetPageImage (size_t WXUNUSED(n)) const override
bool	SetPageImage (size_t n, const std::string &bmp_name)
virtual void	SetFocus () override
virtual bool	DeleteAllPages () override
ButtonsListCtrl *	GetBtnsListCtrl () const
void	SetOverflowButton (wxWindow *button)
size_t	PositionAfter (std::initializer_list< const char * > ids) const
int	FindPageByName (const wxString &id) const
wxWindow *	GetPageByName (const wxString &id) const
bool	SelectPageByName (const wxString &id)
wxString	GetPageName (size_t n) const
wxString	GetSelectedPageName () const
void	UpdateMode ()
void	Rescale ()
void	OnNavigationKey (wxNavigationKeyEvent &event)

Protected Member Functions
virtual void	UpdateSelectedPage (size_t WXUNUSED(newsel)) override
virtual wxBookCtrlEvent *	CreatePageChangingEvent () const override
virtual void	MakeChangedEvent (wxBookCtrlEvent &event) override
virtual wxWindow *	DoRemovePage (size_t page) override
virtual void	DoSize () override
virtual void	DoShowPage (wxWindow *page, bool show) override

Private Member Functions
void	Init ()

Private Attributes
std::vector< wxString >	m_pageNames
wxShowEffect	m_showEffect
wxShowEffect	m_hideEffect
unsigned	m_showTimeout
unsigned	m_hideTimeout

Detailed Description

Constructor & Destructor Documentation

Notebook()

Notebook::Notebook ( wxWindow * parent, wxWindowID winid = wxID_ANY, const wxPoint & pos = wxDefaultPosition, const wxSize & size = wxDefaultSize, wxBoxSizer * side_tools = NULL, long style = 0 )

inline

    {
        Init();
        Create(parent, winid, pos, size, side_tools, style);
    }

References Create(), Init(), and style.

Here is the call graph for this function:

Member Function Documentation

AddPage() [1/2]

bool Notebook::AddPage ( const wxString & id, wxWindow * page, const wxString & text, const std::string & bmp_name = "", bool bSelect = false )

inline

    {
        DoInvalidateBestSize();
        return InsertPage(GetPageCount(), id, page, text, bmp_name, bSelect);
    }

References InsertPage().

Referenced by ShowNewPage().

Here is the call graph for this function:

Here is the caller graph for this function:

AddPage() [2/2]

bool Notebook::AddPage ( wxWindow * page, const wxString & text, bool bSelect = false, int imageId = NO_IMAGE )

inlineoverride

    {
        DoInvalidateBestSize();
        return InsertPage(GetPageCount(), page, text, bSelect, imageId);
    }

References InsertPage().

Here is the call graph for this function:

ChangeSelection()

virtual int Notebook::ChangeSelection ( size_t n )

inlineoverridevirtual

    {
        GetBtnsListCtrl()->SetSelection(n);
        return DoSetSelection(n);
    }

References GetBtnsListCtrl(), and ButtonsListCtrl::SetSelection().

Here is the call graph for this function:

Create()

bool Notebook::Create ( wxWindow * parent, wxWindowID winid = wxID_ANY, const wxPoint & pos = wxDefaultPosition, const wxSize & size = wxDefaultSize, wxBoxSizer * side_tools = NULL, long style = 0 )

inline

    {
        if (!wxBookCtrlBase::Create(parent, winid, pos, size, style | wxBK_TOP))
            return false;
 
        m_bookctrl = new ButtonsListCtrl(this, side_tools);
 
        wxSizer* mainSizer = new wxBoxSizer(IsVertical() ? wxVERTICAL : wxHORIZONTAL);
 
        if (style & wxBK_RIGHT || style & wxBK_BOTTOM)
            mainSizer->Add(0, 0, 1, wxEXPAND, 0);
 
        m_controlSizer = new wxBoxSizer(IsVertical() ? wxHORIZONTAL : wxVERTICAL);
        m_controlSizer->Add(m_bookctrl, wxSizerFlags(1).Expand());
        wxSizerFlags flags;
        if (IsVertical())
            flags.Expand();
        else
            flags.CentreVertical();
        mainSizer->Add(m_controlSizer, flags.Border(wxALL, m_controlMargin));
        SetSizer(mainSizer);
 
        this->Bind(wxCUSTOMEVT_NOTEBOOK_SEL_CHANGED, [this](wxCommandEvent& evt)
        {
            if (int page_idx = evt.GetId(); page_idx >= 0)
                SetSelection(page_idx);
        });
 
        this->Bind(wxEVT_NAVIGATION_KEY, &Notebook::OnNavigationKey, this);
 
        return true;
    }

References OnNavigationKey(), SetSelection(), and style.

Referenced by Notebook().

Here is the call graph for this function:

Here is the caller graph for this function:

CreatePageChangingEvent()

virtual wxBookCtrlEvent * Notebook::CreatePageChangingEvent ( ) const

inlineoverrideprotectedvirtual

    {
        return new wxBookCtrlEvent(wxEVT_BOOKCTRL_PAGE_CHANGING,
                                   GetId());
    }

DeleteAllPages()

virtual bool Notebook::DeleteAllPages ( )

inlineoverridevirtual

    {
        m_pageNames.clear();
        return wxBookCtrlBase::DeleteAllPages();
    }

References m_pageNames.

DoRemovePage()

virtual wxWindow * Notebook::DoRemovePage ( size_t page )

inlineoverrideprotectedvirtual

    {
        wxWindow* const win = wxBookCtrlBase::DoRemovePage(page);
        if (win)
        {
            m_pageNames.erase(m_pageNames.begin() + page);
            GetBtnsListCtrl()->RemovePage(page);
            DoSetSelectionAfterRemoval(page);
        }
 
        return win;
    }

References GetBtnsListCtrl(), m_pageNames, and ButtonsListCtrl::RemovePage().

Here is the call graph for this function:

DoShowPage()

virtual void Notebook::DoShowPage ( wxWindow * page, bool show )

inlineoverrideprotectedvirtual

    {
        if (show)
            page->ShowWithEffect(m_showEffect, m_showTimeout);
        else
            page->HideWithEffect(m_hideEffect, m_hideTimeout);
    }

References m_hideEffect, m_hideTimeout, m_showEffect, and m_showTimeout.

DoSize()

virtual void Notebook::DoSize ( )

inlineoverrideprotectedvirtual

    {
        wxWindow* const page = GetCurrentPage();
        if (page)
            page->SetSize(GetPageRect());
    }

FindPageByName()

int Notebook::FindPageByName ( const wxString & id ) const

inline

    {
        if (id.empty())
            return wxNOT_FOUND;
        for (size_t i = 0; i < m_pageNames.size(); ++i)
            if (m_pageNames[i] == id)
                return static_cast<int>(i);
        return wxNOT_FOUND;
    }

References m_pageNames.

Referenced by GetPageByName(), PositionAfter(), and SelectPageByName().

Here is the caller graph for this function:

GetBtnsListCtrl()

ButtonsListCtrl * Notebook::GetBtnsListCtrl ( ) const

inline

{ return static_cast<ButtonsListCtrl*>(m_bookctrl); }

Referenced by ChangeSelection(), DoRemovePage(), GetPageIcon(), GetPageLabel(), GetPageText(), InsertPage(), Rescale(), SetOverflowButton(), SetPageImage(), SetPageText(), SetSelection(), and UpdateMode().

Here is the caller graph for this function:

GetPageByName()

wxWindow * Notebook::GetPageByName ( const wxString & id ) const

inline

    {
        const int idx = FindPageByName(id);
        return idx == wxNOT_FOUND ? nullptr : GetPage(static_cast<size_t>(idx));
    }

References FindPageByName().

Here is the call graph for this function:

GetPageIcon()

std::string Notebook::GetPageIcon ( size_t n ) const

inline

    {
        wxCHECK_MSG(n < GetPageCount(), std::string(), wxS("Invalid page"));
        return GetBtnsListCtrl()->GetPageIcon(n);
    }

References GetBtnsListCtrl(), and ButtonsListCtrl::GetPageIcon().

Referenced by Slic3r::GUI::ActionRegistry::tab_options().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPageImage()

virtual int Notebook::GetPageImage ( size_t WXUNUSEDn ) const

inlineoverridevirtual

    {
        return NO_IMAGE;
    }

GetPageLabel()

wxString Notebook::GetPageLabel ( size_t n ) const

inline

    {
        wxCHECK_MSG(n < GetPageCount(), wxString(), wxS("Invalid page"));
        return GetBtnsListCtrl()->GetPageLabel(n);
    }

References GetBtnsListCtrl(), and ButtonsListCtrl::GetPageLabel().

Referenced by Slic3r::GUI::ActionRegistry::tab_options().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPageName()

wxString Notebook::GetPageName ( size_t n ) const

inline

    {
        return n < m_pageNames.size() ? m_pageNames[n] : wxString();
    }

References m_pageNames.

Referenced by Slic3r::GUI::ActionRegistry::tab_options().

Here is the caller graph for this function:

GetPageText()

virtual wxString Notebook::GetPageText ( size_t n ) const

inlineoverridevirtual

    {
        wxCHECK_MSG(n < GetPageCount(), wxString(), wxS("Invalid page"));
        return GetBtnsListCtrl()->GetPageText(n);
    }

References GetBtnsListCtrl(), and ButtonsListCtrl::GetPageText().

Here is the call graph for this function:

GetSelectedPageName()

wxString Notebook::GetSelectedPageName ( ) const

inline

    {
        const int sel = GetSelection();
        return sel < 0 ? wxString() : GetPageName(static_cast<size_t>(sel));
    }

Init()

void Notebook::Init ( )

private

{
    // We don't need any border as we don't have anything to separate the
    // page contents from.
    SetInternalBorder(0);
 
    // No effects by default.
    m_showEffect = m_hideEffect = wxSHOW_EFFECT_NONE;
 
    m_showTimeout = m_hideTimeout = 0;
 
    m_pageNames.clear();
 
    /* On Linux, Gstreamer wxMediaCtrl does not seem to get along well with
     * 32-bit X11 visuals (the overlay does not work).  Is this a wxWindows
     * bug?  Is this a Gstreamer bug?  No idea, but it is our problem ... 
     * and anyway, this transparency thing just isn't all that interesting,
     * so we just don't do it on Linux. 
     */
#ifndef __WXGTK__
    SetBackgroundStyle(wxBG_STYLE_TRANSPARENT);
#endif
}

References m_hideEffect, m_hideTimeout, m_pageNames, m_showEffect, and m_showTimeout.

Referenced by Notebook().

Here is the caller graph for this function:

InsertPage() [1/2]

bool Notebook::InsertPage ( size_t n, const wxString & id, wxWindow * page, const wxString & text, const std::string & bmp_name = "", bool bSelect = false, const wxBitmap & bmp = wxNullBitmap )

inline

    {
        if (!wxBookCtrlBase::InsertPage(n, page, text, bSelect))
            return false;
 
        m_pageNames.insert(m_pageNames.begin() + n, id);
        GetBtnsListCtrl()->InsertPage(n, text, bSelect, bmp_name, bmp);
 
        // wxBookCtrlBase::InsertPage() only inserts into the page list and sizes the new
        // page to the current page's rect — it never touches visibility, and a freshly
        // constructed page defaults to shown. Without this it renders on top of whatever
        // page is currently selected until the next SetSelection() call hides it.
        if (!DoSetSelectionAfterInsertion(n, bSelect))
            page->Hide();
 
        return true;
    }

References GetBtnsListCtrl(), ButtonsListCtrl::InsertPage(), and m_pageNames.

Referenced by AddPage(), AddPage(), and InsertPage().

Here is the call graph for this function:

Here is the caller graph for this function:

InsertPage() [2/2]

virtual bool Notebook::InsertPage ( size_t n, wxWindow * page, const wxString & text, bool bSelect = false, int WXUNUSEDimageId = NO_IMAGE )

inlineoverridevirtual

    {
        return InsertPage(n, wxString(), page, text, "", bSelect);
    }

References InsertPage().

Here is the call graph for this function:

MakeChangedEvent()

virtual void Notebook::MakeChangedEvent ( wxBookCtrlEvent & event )

inlineoverrideprotectedvirtual

    {
        event.SetEventType(wxEVT_BOOKCTRL_PAGE_CHANGED);
    }

OnNavigationKey()

void Notebook::OnNavigationKey ( wxNavigationKeyEvent & event )

inline

    {
        if (event.IsWindowChange()) {
            // change pages
            AdvanceSelection(event.GetDirection());
        }
        else {
            // we get this event in 3 cases
            //
            // a) one of our pages might have generated it because the user TABbed
            // out from it in which case we should propagate the event upwards and
            // our parent will take care of setting the focus to prev/next sibling
            //
            // or
            //
            // b) the parent panel wants to give the focus to us so that we
            // forward it to our selected page. We can't deal with this in
            // OnSetFocus() because we don't know which direction the focus came
            // from in this case and so can't choose between setting the focus to
            // first or last panel child
            //
            // or
            //
            // c) we ourselves (see MSWTranslateMessage) generated the event
            //
            wxWindow* const parent = GetParent();
 
            // the wxObject* casts are required to avoid MinGW GCC 2.95.3 ICE
            const bool isFromParent = event.GetEventObject() == (wxObject*)parent;
            const bool isFromSelf = event.GetEventObject() == (wxObject*)this;
            const bool isForward = event.GetDirection();
 
            if (isFromSelf && !isForward)
            {
                // focus is currently on notebook tab and should leave
                // it backwards (Shift-TAB)
                event.SetCurrentFocus(this);
                parent->HandleWindowEvent(event);
            }
            else if (isFromParent || isFromSelf)
            {
                // no, it doesn't come from child, case (b) or (c): forward to a
                // page but only if entering notebook page (i.e. direction is
                // backwards (Shift-TAB) comething from out-of-notebook, or
                // direction is forward (TAB) from ourselves),
                if (m_selection != wxNOT_FOUND &&
                    (!event.GetDirection() || isFromSelf))
                {
                    // so that the page knows that the event comes from it's parent
                    // and is being propagated downwards
                    event.SetEventObject(this);
 
                    wxWindow* page = m_pages[m_selection];
                    if (!page->HandleWindowEvent(event))
                    {
                        page->SetFocus();
                    }
                    //else: page manages focus inside it itself
                }
                else // otherwise set the focus to the notebook itself
                {
                    SetFocus();
                }
            }
            else
            {
                // it comes from our child, case (a), pass to the parent, but only
                // if the direction is forwards. Otherwise set the focus to the
                // notebook itself. The notebook is always the 'first' control of a
                // page.
                if (!isForward)
                {
                    SetFocus();
                }
                else if (parent)
                {
                    event.SetCurrentFocus(this);
                    parent->HandleWindowEvent(event);
                }
            }
        }
    }

References SetFocus().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

PositionAfter()

size_t Notebook::PositionAfter ( std::initializer_list< const char * > ids ) const

inline

    {
        for (const char* id : ids)
            if (const int idx = FindPageByName(id); idx != wxNOT_FOUND)
                return static_cast<size_t>(idx) + 1;
        return GetPageCount();
    }

References FindPageByName().

Here is the call graph for this function:

Rescale()

void Notebook::Rescale ( )

inline

    {
        GetBtnsListCtrl()->Rescale();
    }

References GetBtnsListCtrl(), and ButtonsListCtrl::Rescale().

Here is the call graph for this function:

SelectPageByName()

bool Notebook::SelectPageByName ( const wxString & id )

inline

    {
        const int idx = FindPageByName(id);
        if (idx == wxNOT_FOUND)
            return false;
        SetSelection(static_cast<size_t>(idx));
        return true;
    }

References FindPageByName(), and SetSelection().

Here is the call graph for this function:

SetEffect()

void Notebook::SetEffect ( wxShowEffect effect )

inline

    {
        SetEffects(effect, effect);
    }

References SetEffects().

Here is the call graph for this function:

SetEffects()

void Notebook::SetEffects ( wxShowEffect showEffect, wxShowEffect hideEffect )

inline

    {
        m_showEffect = showEffect;
        m_hideEffect = hideEffect;
    }

References m_hideEffect, and m_showEffect.

Referenced by SetEffect().

Here is the caller graph for this function:

SetEffectsTimeouts()

void Notebook::SetEffectsTimeouts ( unsigned showTimeout, unsigned hideTimeout )

inline

    {
        m_showTimeout = showTimeout;
        m_hideTimeout = hideTimeout;
    }

References m_hideTimeout, and m_showTimeout.

Referenced by SetEffectTimeout().

Here is the caller graph for this function:

SetEffectTimeout()

void Notebook::SetEffectTimeout ( unsigned timeout )

inline

    {
        SetEffectsTimeouts(timeout, timeout);
    }

References SetEffectsTimeouts().

Here is the call graph for this function:

SetFocus()

virtual void Notebook::SetFocus ( )

inlineoverridevirtual

    {
        wxWindow* const page = GetCurrentPage();
        if (page)
            page->SetFocus();
    }

Referenced by OnNavigationKey().

Here is the caller graph for this function:

SetOverflowButton()

void Notebook::SetOverflowButton ( wxWindow * button )

inline

{ GetBtnsListCtrl()->SetOverflowButton(button); }

References GetBtnsListCtrl(), and ButtonsListCtrl::SetOverflowButton().

Here is the call graph for this function:

SetPageImage() [1/2]

bool Notebook::SetPageImage ( size_t n, const std::string & bmp_name )

inline

    {
        return GetBtnsListCtrl()->SetPageImage(n, bmp_name);
    }

References GetBtnsListCtrl(), and ButtonsListCtrl::SetPageImage().

Here is the call graph for this function:

SetPageImage() [2/2]

virtual bool Notebook::SetPageImage ( size_t WXUNUSEDn, int WXUNUSEDimageId )

inlineoverridevirtual

    {
        return false;
    }

SetPageText()

virtual bool Notebook::SetPageText ( size_t n, const wxString & strText )

inlineoverridevirtual

    {
        wxCHECK_MSG(n < GetPageCount(), false, wxS("Invalid page"));
 
        GetBtnsListCtrl()->SetPageText(n, strText);
 
        return true;
    }

References GetBtnsListCtrl(), and ButtonsListCtrl::SetPageText().

Here is the call graph for this function:

SetSelection()

virtual int Notebook::SetSelection ( size_t n )

inlineoverridevirtual

    {
        int ret = DoSetSelection(n, SetSelection_SendEvent);
        int new_sel = GetSelection();
        //check the new_sel firstly
        if (new_sel != n) {
            //not allowed, skip it
            return ret;
        }
        GetBtnsListCtrl()->SetSelection(n);
 
        // check that only the selected page is visible and others are hidden:
        for (size_t page = 0; page < m_pages.size(); page++) {
            wxWindow* win_a = GetPage(page);
            wxWindow* win_b = GetPage(n);
            if (page != n && GetPage(page) != GetPage(n)) {
                m_pages[page]->Hide();
            }
        }
 
        return ret;
    }

References GetBtnsListCtrl(), and ButtonsListCtrl::SetSelection().

Referenced by Create(), and SelectPageByName().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowNewPage()

bool Notebook::ShowNewPage ( wxWindow * page )

inline

    {
        return AddPage(page, wxString(), false, NO_IMAGE);
    }

References AddPage().

Here is the call graph for this function:

UpdateMode()

void Notebook::UpdateMode ( )

inline

    {
        GetBtnsListCtrl()->UpdateMode();
    }

References GetBtnsListCtrl(), and ButtonsListCtrl::UpdateMode().

Here is the call graph for this function:

UpdateSelectedPage()

virtual void Notebook::UpdateSelectedPage ( size_t WXUNUSEDnewsel )

inlineoverrideprotectedvirtual

    {
        // Nothing to do here, but must be overridden to avoid the assert in
        // the base class version.
    }

Member Data Documentation

m_hideEffect

wxShowEffect Notebook::m_hideEffect

private

Referenced by DoShowPage(), Init(), and SetEffects().

m_hideTimeout

unsigned Notebook::m_hideTimeout

private

Referenced by DoShowPage(), Init(), and SetEffectsTimeouts().

m_pageNames

std::vector<wxString> Notebook::m_pageNames

private

Referenced by DeleteAllPages(), DoRemovePage(), FindPageByName(), GetPageName(), Init(), and InsertPage().

m_showEffect

wxShowEffect Notebook::m_showEffect

private

Referenced by DoShowPage(), Init(), and SetEffects().

m_showTimeout

unsigned Notebook::m_showTimeout

private

Referenced by DoShowPage(), Init(), and SetEffectsTimeouts().

---

The documentation for this class was generated from the following files:

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Notebook.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Notebook.cpp