kicad_tab_art.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_TAB_ART_H
#define KICAD_TAB_ART_H
 
#include <functional>
 
#include <wx/version.h>
#include <wx/aui/auibook.h>
#include <wx/aui/tabart.h>
 

struct TAB_VISUAL_STATE
{
    bool italic       = false;
    bool bold         = false;
    bool showAsterisk = false;
};
 

TAB_VISUAL_STATE ResolveTabVisualState( bool aPreview, bool aModified );
 

class KICAD_TAB_ART : public wxAuiDefaultTabArt
{
public:
    using STATE_FN = std::function<TAB_VISUAL_STATE( wxWindow* )>;
 
    explicit KICAD_TAB_ART( STATE_FN aProvider );
 
    wxAuiTabArt* Clone() override;
 
#if wxCHECK_VERSION( 3, 3, 0 )
    // wxWidgets 3.3 rewrote wxAUI to a page-based art interface and the tab strip now renders through
    // DrawPageTab/GetPageTabSize. The legacy DrawTab/GetTabSize are no longer on the draw path for the
    // default (flat) art, so the decorations must hook the page-based methods instead.
    int DrawPageTab( wxDC& aDc, wxWindow* aWnd, wxAuiNotebookPage& aPage,
                     const wxRect& aRect ) override;
 
    wxSize GetPageTabSize( wxReadOnlyDC& aDc, wxWindow* aWnd, const wxAuiNotebookPage& aPage,
                           int* aXExtent = nullptr ) override;
#else
    void DrawTab( wxDC& aDc, wxWindow* aWnd, const wxAuiNotebookPage& aPage, const wxRect& aInRect,
                  int aCloseButtonState, wxRect* aOutTabRect, wxRect* aOutButtonRect,
                  int* aXExtent ) override;
 
    wxSize GetTabSize( wxDC& aDc, wxWindow* aWnd, const wxString& aCaption,
                       const wxBitmapBundle& aBitmap, bool aActive, int aCloseButtonState,
                       int* aXExtent ) override;
#endif
 
private:
    TAB_VISUAL_STATE stateFor( wxWindow* aPageWindow ) const;

    wxFont decoratedFont( const TAB_VISUAL_STATE& aState, bool aActive ) const;
 
    STATE_FN m_stateFn;
};
 
#endif // KICAD_TAB_ART_H