cbauibook.h

Go to the documentation of this file.

/*
 * This file is part of the Code::Blocks IDE and licensed under the GNU Lesser General Public License, version 3
 * http://www.gnu.org/licenses/lgpl-3.0.html
 */

#ifndef CBAUIBOOK_H_INCLUDED
#define CBAUIBOOK_H_INCLUDED

#include "prep.h"
#include "settings.h" // DLLIMPORT

#include <vector>

#include <wx/aui/auibook.h>
#include <wx/dynarray.h>

class wxTipWindow;
class cbAuiNotebook;

WX_DEFINE_ARRAY_PTR(wxAuiTabCtrl*,cbAuiTabCtrlArray);
WX_DEFINE_ARRAY_PTR(cbAuiNotebook*,cbAuiNotebookArray);

class DLLIMPORT cbAuiNotebook : public wxAuiNotebook
{
    public:
        cbAuiNotebook(wxWindow* pParent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxAUI_NB_DEFAULT_STYLE);
        ~cbAuiNotebook() override;

        void AdvanceSelection(bool forward = true);
        wxString SavePerspective(const wxString projectTitle = wxEmptyString);
        bool LoadPerspective(const wxString& layout, bool mergeLayouts = false);
        int GetTabIndexFromTooltip(const wxString& text);
        int GetTabPositionFromIndex(int index);
#if !wxCHECK_VERSION(3, 0, 0)

        bool SetPageToolTip(size_t idx, const wxString & text );
        wxString GetPageToolTip(size_t idx  );
#endif // !wxCHECK_VERSION(3, 0, 0)

        void MinimizeFreeSpace();
        bool DeletePage(size_t page);
        bool RemovePage(size_t page);
        bool MovePage(wxWindow* page, size_t new_idx);
        bool AddPage(wxWindow* page,
                     const wxString& caption,
                     bool select = false,
                     const wxBitmap& bitmap = wxNullBitmap);
        bool InsertPage(size_t page_idx,
                        wxWindow* page,
                        const wxString& caption,
                        bool select = false,
                        const wxBitmap& bitmap = wxNullBitmap);
        void SetZoom(int zoom);
        void FocusActiveTabCtrl();

        wxAuiTabCtrl* GetTabCtrl(wxWindow *page);

        void GetPagesInTabCtrl(std::vector<wxWindow*> &result, wxWindow *page);
    protected:
        wxString UniqueIdFromTooltip(const wxString& text);
        void MinimizeFreeSpace(wxAuiTabCtrl* tabCtrl);
#if wxCHECK_VERSION(3, 0, 0)
        void OnNavigationKeyNotebook(wxNavigationKeyEvent& event);
#else
        void OnNavigationKey(wxNavigationKeyEvent& event);
#endif // wxCHECK_VERSION(3, 0, 0)

        void OnIdle(cb_unused wxIdleEvent& event);
#if !wxCHECK_VERSION(3, 0, 0)

        void OnMotion(wxMouseEvent& event);
#endif // !wxCHECK_VERSION(3, 0, 0)

        void OnTabCtrlDblClick(wxMouseEvent& event);
        void OnTabCtrlMouseWheel(wxMouseEvent& event);
        void OnResize(wxSizeEvent& event);
        void OnDragDone(wxAuiNotebookEvent& event);
#ifdef __WXMSW__

        void OnEnterTabCtrl(wxMouseEvent& event);
        void OnLeaveTabCtrl(wxMouseEvent& event);
        // hack needed on wxMSW, because only focused windows get mousewheel-events
        bool IsFocusStored(wxWindow* page);
        void StoreFocus();
        void RestoreFocus();
#endif // __WXMSW__

        void ResetTabCtrlEvents();
        void UpdateTabControlsArray();
        bool CheckKeyModifier();
        cbAuiTabCtrlArray m_TabCtrls;
#ifdef __WXMSW__
        // needed for wxMSW-hack, see above
        int m_LastSelected;
        long m_LastId;
#endif // __WXMSW__
#if !wxCHECK_VERSION(3, 0, 0)

        bool m_HasToolTip;
#endif // !wxCHECK_VERSION(3, 0, 0)

        bool m_SetZoomOnIdle;
        bool m_MinimizeFreeSpaceOnIdle;
        wxSize m_TabCtrlSize;

//static stuff (common to all cbAuiNotebooks)
    public:
        static void UseToolTips(bool use = true);
        static void AllowScrolling(bool allow = true);
        static void SetModKeys(wxString keys = _T("Strg"));
        static void UseModToAdvance(bool use = false);
        static void InvertAdvanceDirection(bool invert = false);
        static void InvertMoveDirection(bool invert = false);
    protected:
        static bool s_UseTabTooltips;
        static bool s_AllowMousewheel;
        static cbAuiNotebookArray s_cbAuiNotebookArray;
        static wxString s_modKeys;
        static bool s_modToAdvance;
        static int s_moveDirection;
        static int s_advanceDirection;

    private:
        // the following two using directives remove the "-Woverloaded-virtual" warnings
        using wxAuiNotebook::AddPage;
        using wxAuiNotebook::InsertPage;

        DECLARE_EVENT_TABLE()
};

#endif // CBAUIBOOK_H_INCLUDED