symbol_viewer_frame.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
 
#ifndef LIB_VIEW_FRAME_H__
#define LIB_VIEW_FRAME_H__
 
#include <sch_base_frame.h>
#include <sch_screen.h>
#include <tool/selection.h>
 
class WX_LISTBOX;
class wxSearchCtrl;
class SYMBOL_LIBRARY_FILTER;
class LIB_SYMBOL;
class SYMBOL_LIB_TABLE_ROW;
 
 
class SYMBOL_VIEWER_FRAME : public SCH_BASE_FRAME
{
public:
 
    SYMBOL_VIEWER_FRAME( KIWAY* aKiway, wxWindow* aParent );
 
    ~SYMBOL_VIEWER_FRAME();
 
    void OnSize( wxSizeEvent& event ) override;
 
    bool ReCreateLibList();
 
    bool ReCreateSymbolList();
 
    void DisplayLibInfos();
    void doCloseWindow() override;
    void CloseLibraryViewer( wxCommandEvent& event );
 
    void ClickOnLibList( wxCommandEvent& event );
    void ClickOnSymbolList( wxCommandEvent& event );
 
    void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
    void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    WINDOW_SETTINGS* GetWindowSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    void CommonSettingsChanged( int aFlags ) override;
 
    void SetSelectedLibrary( const wxString& aLibName,
                             const wxString& aSubLibName = wxEmptyString );
 
    void SetSelectedSymbol( const wxString& aSymbolName );
 
    // Accessors:
    void SetUnitAndBodyStyle( int aUnit, int aBodyStyle );
    int GetUnit() const { return m_unit; }
    int GetBodyStyle() const { return m_bodyStyle; }
 
    LIB_SYMBOL* GetSelectedSymbol() const;
 
    const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
 
    SELECTION& GetCurrentSelection() override;
 
    void KiwayMailIn( KIWAY_EXPRESS& mail ) override;
 
protected:
    void configureToolbars() override;
 
    void setupUIConditions() override;
 
    void doReCreateMenuBar() override;
 
private:
    // Set up the tool framework.
    void setupTools();
 
    void OnActivate( wxActivateEvent& event );
 
    void DClickOnSymbolList( wxCommandEvent& event );
 
    void onUpdateUnitChoice( wxUpdateUIEvent& aEvent );
 
    void OnLibFilter( wxCommandEvent& aEvent );
    void OnSymFilter( wxCommandEvent& aEvent );
    void OnCharHook( wxKeyEvent& aEvent ) override;
 
    void onSelectNextSymbol( wxCommandEvent& aEvent );
    void onSelectPreviousSymbol( wxCommandEvent& aEvent );
    void onSelectSymbolUnit( wxCommandEvent& aEvent );
 
    void updatePreviewSymbol();
 
    void loadAllLibraries();
 
private:
    wxChoice*           m_unitChoice;
 
    wxSearchCtrl*       m_libFilter;
    WX_LISTBOX*         m_libList;             // The list of libraries.
    int                 m_libListWidth;        // Last width of the window.
 
    wxSearchCtrl*       m_symbolFilter;
    WX_LISTBOX*         m_symbolList;          // The list of symbols.
    int                 m_symbolListWidth;     // Last width of the window.
 
    // Filters to build list of libs/list of symbols.
    bool                m_listPowerOnly;
    wxArrayString       m_allowedLibs;
 
    static LIB_ID       m_currentSymbol;
 
    static int          m_unit;
    static int          m_bodyStyle;
    static bool         m_show_progress;
 
    bool                m_selection_changed;
 
    std::unique_ptr<LIB_SYMBOL> m_previewItem;
 
    DECLARE_EVENT_TABLE()
};
 
#endif  // LIB_VIEW_FRAME_H__