2012-09-11 19:03:21 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
2014-01-19 16:36:12 +00:00
|
|
|
* Copyright (C) 2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
|
|
* Copyright (C) 2008-2014 Wayne Stambaugh <stambaughw@verizon.net>
|
|
|
|
* Copyright (C) 2004-2014 KiCad Developers, see change_log.txt for contributors.
|
2012-09-11 19:03:21 +00:00
|
|
|
*
|
|
|
|
* 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
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @file viewlib_frame.h
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef LIBVIEWFRM_H_
|
|
|
|
#define LIBVIEWFRM_H_
|
|
|
|
|
|
|
|
|
|
|
|
#include <wx/gdicmn.h>
|
|
|
|
|
|
|
|
#include <sch_base_frame.h>
|
|
|
|
#include <class_sch_screen.h>
|
|
|
|
|
|
|
|
class wxListBox;
|
Modular KiCad Blueprint Milestone B), major portions:
*) When kicad.exe closes a project, close any open KIFACEs so that they cannot
get disassociated from their true PROJECT.
*) Allow loading eeschema library editor from kicad.exe
*) Allow loading pcbnew library editor from kicad.exe
*) Rename LIB_COMPONENT to LIB_PART.
*) Add class PART_LIBS, and PART_LIB.
*) Make PART_LIBS non-global, i.e. PROJECT specific.
*) Implement "data on demand" for PART_LIBS
*) Implement "data on demand" for schematic SEARCH_STACK.
*) Use RSTRINGs to retain eeschema editor's notion of last library and part being edited.
*) Get rid of library search on every SCH_COMPONENT::Draw() call, instead use
a weak pointer.
*) Remove all chdir() calls so projects don't need to be CWD.
*) Romove APPEND support from OpenProjectFiles().
*) Make OpenProjectFiles() robust, even for creating new projects.
*) Load EESCHEMA colors in the KIWAY::OnKiwayStart() rather in window open,
and save them in the .eeschema config file, not in the project file.
*) Fix bug with wxDir() while accessing protected dirs in kicad.exe
*) Consolidate template copying into PROJECT class, not in kicad.exe source.
*) Generally untangle eeschema, making its libraries not global but rather
held in the PROJECT.
2014-08-13 20:28:54 +00:00
|
|
|
class PART_LIB;
|
2015-04-16 15:26:51 +00:00
|
|
|
class SCHLIB_FILTER;
|
2012-09-11 19:03:21 +00:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Component library viewer main window.
|
|
|
|
*/
|
|
|
|
class LIB_VIEW_FRAME : public SCH_BASE_FRAME
|
|
|
|
{
|
|
|
|
public:
|
Modular-Kicad milestone B), major portions:
*) Rework the set language support, simplify it by using KIWAY. Now any major
frame with a "change language" menu can change the language for all KIWAY_PLAYERs
in the whole KIWAY. Multiple KIWAYs are not supported yet.
*) Simplify "modal wxFrame" support, and add that support exclusively to
KIWAY_PLAYER where it is inherited by all derivatives. The function
KIWAY_PLAYER::ShowModal() is in the vtable and so is cross module capable.
*) Remove the requirements and assumptions that the wxFrame hierarchy always
had PCB_EDIT_FRAME and SCH_EDIT_FRAME as immediate parents of their viewers
and editors. This is no longer the case, nor required.
*) Use KIWAY::Player() everywhere to make KIWAY_PLAYERs, this registers the
KIWAY_PLAYER within the KIWAY and makes it very easy to find an open frame
quickly. It also gives control to the KIWAY as to frame hierarchical
relationships.
*) Change single_top to use the KIWAY for loading a KIFACE and instantiating
the single KIWAY_PLAYER, see bullet immediately above.
*) Add KIWAY::OnKiwayEnd() and call it from PGM_BASE at program termination, this
gives the KIFACEs a chance to save their final configuration dope to disk.
*) Add dedicated FRAME_T's for the modal frames, so m_Ident can be tested and
these modal frames are distinctly different than their non-modal equivalents.
KIWAY_PLAYER::IsModal() is !not! a valid test during the wxFrame's constructor,
so this is another important reason for having a dedicated FRAME_T for each
modal wxFrame.
On balance, more lines were deleted than were added to achieve all this.
2014-05-03 17:40:19 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor
|
2014-11-02 16:25:04 +00:00
|
|
|
* @param aKiway
|
|
|
|
* @param aParent = the parent frame
|
Modular-Kicad milestone B), major portions:
*) Rework the set language support, simplify it by using KIWAY. Now any major
frame with a "change language" menu can change the language for all KIWAY_PLAYERs
in the whole KIWAY. Multiple KIWAYs are not supported yet.
*) Simplify "modal wxFrame" support, and add that support exclusively to
KIWAY_PLAYER where it is inherited by all derivatives. The function
KIWAY_PLAYER::ShowModal() is in the vtable and so is cross module capable.
*) Remove the requirements and assumptions that the wxFrame hierarchy always
had PCB_EDIT_FRAME and SCH_EDIT_FRAME as immediate parents of their viewers
and editors. This is no longer the case, nor required.
*) Use KIWAY::Player() everywhere to make KIWAY_PLAYERs, this registers the
KIWAY_PLAYER within the KIWAY and makes it very easy to find an open frame
quickly. It also gives control to the KIWAY as to frame hierarchical
relationships.
*) Change single_top to use the KIWAY for loading a KIFACE and instantiating
the single KIWAY_PLAYER, see bullet immediately above.
*) Add KIWAY::OnKiwayEnd() and call it from PGM_BASE at program termination, this
gives the KIFACEs a chance to save their final configuration dope to disk.
*) Add dedicated FRAME_T's for the modal frames, so m_Ident can be tested and
these modal frames are distinctly different than their non-modal equivalents.
KIWAY_PLAYER::IsModal() is !not! a valid test during the wxFrame's constructor,
so this is another important reason for having a dedicated FRAME_T for each
modal wxFrame.
On balance, more lines were deleted than were added to achieve all this.
2014-05-03 17:40:19 +00:00
|
|
|
* @param aFrameType must be given either FRAME_SCH_LIB_VIEWER or
|
|
|
|
* FRAME_SCH_LIB_VIEWER_MODAL
|
2014-11-02 16:25:04 +00:00
|
|
|
* @param aLibrary = the library to open when starting (default = NULL)
|
Modular-Kicad milestone B), major portions:
*) Rework the set language support, simplify it by using KIWAY. Now any major
frame with a "change language" menu can change the language for all KIWAY_PLAYERs
in the whole KIWAY. Multiple KIWAYs are not supported yet.
*) Simplify "modal wxFrame" support, and add that support exclusively to
KIWAY_PLAYER where it is inherited by all derivatives. The function
KIWAY_PLAYER::ShowModal() is in the vtable and so is cross module capable.
*) Remove the requirements and assumptions that the wxFrame hierarchy always
had PCB_EDIT_FRAME and SCH_EDIT_FRAME as immediate parents of their viewers
and editors. This is no longer the case, nor required.
*) Use KIWAY::Player() everywhere to make KIWAY_PLAYERs, this registers the
KIWAY_PLAYER within the KIWAY and makes it very easy to find an open frame
quickly. It also gives control to the KIWAY as to frame hierarchical
relationships.
*) Change single_top to use the KIWAY for loading a KIFACE and instantiating
the single KIWAY_PLAYER, see bullet immediately above.
*) Add KIWAY::OnKiwayEnd() and call it from PGM_BASE at program termination, this
gives the KIFACEs a chance to save their final configuration dope to disk.
*) Add dedicated FRAME_T's for the modal frames, so m_Ident can be tested and
these modal frames are distinctly different than their non-modal equivalents.
KIWAY_PLAYER::IsModal() is !not! a valid test during the wxFrame's constructor,
so this is another important reason for having a dedicated FRAME_T for each
modal wxFrame.
On balance, more lines were deleted than were added to achieve all this.
2014-05-03 17:40:19 +00:00
|
|
|
*/
|
|
|
|
LIB_VIEW_FRAME( KIWAY* aKiway, wxWindow* aParent,
|
Modular KiCad Blueprint Milestone B), major portions:
*) When kicad.exe closes a project, close any open KIFACEs so that they cannot
get disassociated from their true PROJECT.
*) Allow loading eeschema library editor from kicad.exe
*) Allow loading pcbnew library editor from kicad.exe
*) Rename LIB_COMPONENT to LIB_PART.
*) Add class PART_LIBS, and PART_LIB.
*) Make PART_LIBS non-global, i.e. PROJECT specific.
*) Implement "data on demand" for PART_LIBS
*) Implement "data on demand" for schematic SEARCH_STACK.
*) Use RSTRINGs to retain eeschema editor's notion of last library and part being edited.
*) Get rid of library search on every SCH_COMPONENT::Draw() call, instead use
a weak pointer.
*) Remove all chdir() calls so projects don't need to be CWD.
*) Romove APPEND support from OpenProjectFiles().
*) Make OpenProjectFiles() robust, even for creating new projects.
*) Load EESCHEMA colors in the KIWAY::OnKiwayStart() rather in window open,
and save them in the .eeschema config file, not in the project file.
*) Fix bug with wxDir() while accessing protected dirs in kicad.exe
*) Consolidate template copying into PROJECT class, not in kicad.exe source.
*) Generally untangle eeschema, making its libraries not global but rather
held in the PROJECT.
2014-08-13 20:28:54 +00:00
|
|
|
FRAME_T aFrameType, PART_LIB* aLibrary = NULL );
|
2012-09-11 19:03:21 +00:00
|
|
|
|
|
|
|
~LIB_VIEW_FRAME();
|
|
|
|
|
2012-09-12 09:53:11 +00:00
|
|
|
/**
|
|
|
|
* Function GetLibViewerFrameName (static)
|
|
|
|
* @return the frame name used when creating the frame
|
|
|
|
* used to get a reference to this frame, if exists
|
|
|
|
*/
|
|
|
|
static const wxChar* GetLibViewerFrameName();
|
|
|
|
|
2012-09-11 19:03:21 +00:00
|
|
|
void OnSize( wxSizeEvent& event );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function ReCreateListLib
|
|
|
|
*
|
|
|
|
* Creates or recreates the list of current loaded libraries.
|
|
|
|
* This list is sorted, with the library cache always at end of the list
|
|
|
|
*/
|
|
|
|
void ReCreateListLib();
|
|
|
|
|
|
|
|
void ReCreateListCmp();
|
|
|
|
void Process_Special_Functions( wxCommandEvent& event );
|
|
|
|
void DisplayLibInfos();
|
|
|
|
void RedrawActiveWindow( wxDC* DC, bool EraseBg );
|
|
|
|
void OnCloseWindow( wxCloseEvent& Event );
|
2014-10-15 11:40:38 +00:00
|
|
|
void CloseLibraryViewer( wxCommandEvent& event );
|
2012-09-11 19:03:21 +00:00
|
|
|
void ReCreateHToolbar();
|
|
|
|
void ReCreateVToolbar();
|
2014-10-15 11:40:38 +00:00
|
|
|
void ReCreateMenuBar();
|
|
|
|
|
2012-09-11 19:03:21 +00:00
|
|
|
void OnLeftClick( wxDC* DC, const wxPoint& MousePos );
|
|
|
|
double BestZoom();
|
|
|
|
void ClickOnLibList( wxCommandEvent& event );
|
|
|
|
void ClickOnCmpList( wxCommandEvent& event );
|
|
|
|
void OnSetRelativeOffset( wxCommandEvent& event );
|
|
|
|
|
2014-08-29 20:23:40 +00:00
|
|
|
bool GeneralControl( wxDC* aDC, const wxPoint& aPosition, int aHotKey = 0 );
|
2012-09-11 19:03:21 +00:00
|
|
|
|
2014-10-15 11:40:38 +00:00
|
|
|
/**
|
|
|
|
* Function OnHotKey
|
|
|
|
* handle hot key events.
|
|
|
|
* <p?
|
|
|
|
* Some commands are relative to the item under the mouse cursor. Commands are
|
|
|
|
* case insensitive
|
|
|
|
* </p>
|
|
|
|
*/
|
|
|
|
bool OnHotKey( wxDC* aDC, int aHotKey, const wxPoint& aPosition, EDA_ITEM* aItem = NULL );
|
|
|
|
|
* KIWAY Milestone A): Make major modules into DLL/DSOs.
! The initial testing of this commit should be done using a Debug build so that
all the wxASSERT()s are enabled. Also, be sure and keep enabled the
USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it
off is senseless anyways. If you want stable code, go back to a prior version,
the one tagged with "stable".
* Relocate all functionality out of the wxApp derivative into more finely
targeted purposes:
a) DLL/DSO specific
b) PROJECT specific
c) EXE or process specific
d) configuration file specific data
e) configuration file manipulations functions.
All of this functionality was blended into an extremely large wxApp derivative
and that was incompatible with the desire to support multiple concurrently
loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects.
An amazing amount of organization come from simply sorting each bit of
functionality into the proper box.
* Switch to wxConfigBase from wxConfig everywhere except instantiation.
* Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD,
PGM_SINGLE_TOP,
* Remove "Return" prefix on many function names.
* Remove obvious comments from CMakeLists.txt files, and from else() and endif()s.
* Fix building boost for use in a DSO on linux.
* Remove some of the assumptions in the CMakeLists.txt files that windows had
to be the host platform when building windows binaries.
* Reduce the number of wxStrings being constructed at program load time via
static construction.
* Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that
these functions are useful even when the wxConfigBase comes from another
source, as is the case in the KICAD_MANAGER_FRAME.
* Move the setting of the KIPRJMOD environment variable into class PROJECT,
so that it can be moved into a project variable soon, and out of FP_LIB_TABLE.
* Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all
its child wxFrames and wxDialogs now have a Kiway() member function which
returns a KIWAY& that that window tree branch is in support of. This is like
wxWindows DNA in that child windows get this member with proper value at time
of construction.
* Anticipate some of the needs for milestones B) and C) and make code
adjustments now in an effort to reduce work in those milestones.
* No testing has been done for python scripting, since milestone C) has that
being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
|
|
|
void LoadSettings( wxConfigBase* aCfg );
|
|
|
|
void SaveSettings( wxConfigBase* aCfg );
|
2012-09-11 19:03:21 +00:00
|
|
|
|
2015-04-16 15:26:51 +00:00
|
|
|
/**
|
|
|
|
* set a filter to display only libraries and/or components
|
|
|
|
* which match the filter
|
|
|
|
*
|
|
|
|
* @param aFilter is a filter to pass the allowed library name list
|
|
|
|
* and/or some other filter
|
|
|
|
* see SCH_BASE_FRAME::SelectComponentFromLibrary() for details.
|
|
|
|
* if aFilter == NULL, remove all filtering
|
|
|
|
*/
|
|
|
|
void SetFilter( const SCHLIB_FILTER* aFilter );
|
|
|
|
|
2014-02-24 10:52:08 +00:00
|
|
|
/**
|
|
|
|
* Set the selected library in the library window.
|
|
|
|
*
|
|
|
|
* @param aLibName name of the library to be selected.
|
|
|
|
*/
|
|
|
|
void SetSelectedLibrary( const wxString& aLibName );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the selected component.
|
|
|
|
*
|
2014-11-02 16:25:04 +00:00
|
|
|
* @param aComponentName : the name of the component to be selected.
|
2014-02-24 10:52:08 +00:00
|
|
|
*/
|
|
|
|
void SetSelectedComponent( const wxString& aComponentName );
|
|
|
|
|
2014-11-02 16:25:04 +00:00
|
|
|
// Accessors:
|
2014-02-24 10:52:08 +00:00
|
|
|
void SetUnit( int aUnit ) { m_unit = aUnit; }
|
|
|
|
int GetUnit( void ) { return m_unit; }
|
2012-09-11 19:03:21 +00:00
|
|
|
|
2014-02-24 10:52:08 +00:00
|
|
|
void SetConvert( int aConvert ) { m_convert = aConvert; }
|
|
|
|
int GetConvert( void ) { return m_convert; }
|
2012-09-11 19:03:21 +00:00
|
|
|
|
|
|
|
private:
|
|
|
|
/**
|
|
|
|
* Function OnActivate
|
|
|
|
* is called when the frame frame is activate to reload the libraries and component lists
|
|
|
|
* that can be changed by the schematic editor or the library editor.
|
|
|
|
*/
|
|
|
|
virtual void OnActivate( wxActivateEvent& event );
|
|
|
|
|
|
|
|
void SelectCurrentLibrary();
|
|
|
|
void SelectAndViewLibraryPart( int option );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function ExportToSchematicLibraryPart
|
|
|
|
* exports the current component to schematic and close the library browser.
|
|
|
|
*/
|
|
|
|
void ExportToSchematicLibraryPart( wxCommandEvent& event );
|
Modular KiCad Blueprint Milestone B), major portions:
*) When kicad.exe closes a project, close any open KIFACEs so that they cannot
get disassociated from their true PROJECT.
*) Allow loading eeschema library editor from kicad.exe
*) Allow loading pcbnew library editor from kicad.exe
*) Rename LIB_COMPONENT to LIB_PART.
*) Add class PART_LIBS, and PART_LIB.
*) Make PART_LIBS non-global, i.e. PROJECT specific.
*) Implement "data on demand" for PART_LIBS
*) Implement "data on demand" for schematic SEARCH_STACK.
*) Use RSTRINGs to retain eeschema editor's notion of last library and part being edited.
*) Get rid of library search on every SCH_COMPONENT::Draw() call, instead use
a weak pointer.
*) Remove all chdir() calls so projects don't need to be CWD.
*) Romove APPEND support from OpenProjectFiles().
*) Make OpenProjectFiles() robust, even for creating new projects.
*) Load EESCHEMA colors in the KIWAY::OnKiwayStart() rather in window open,
and save them in the .eeschema config file, not in the project file.
*) Fix bug with wxDir() while accessing protected dirs in kicad.exe
*) Consolidate template copying into PROJECT class, not in kicad.exe source.
*) Generally untangle eeschema, making its libraries not global but rather
held in the PROJECT.
2014-08-13 20:28:54 +00:00
|
|
|
void ViewOneLibraryContent( PART_LIB* Lib, int Flag );
|
2012-09-11 19:03:21 +00:00
|
|
|
bool OnRightClick( const wxPoint& MousePos, wxMenu* PopMenu );
|
2012-12-04 19:04:04 +00:00
|
|
|
void DClickOnCmpList( wxCommandEvent& event );
|
2012-09-11 19:03:21 +00:00
|
|
|
|
2015-04-16 15:26:51 +00:00
|
|
|
// Private members:
|
2014-02-24 10:52:08 +00:00
|
|
|
wxComboBox* m_selpartBox;
|
|
|
|
|
|
|
|
// List of libraries (for selection )
|
|
|
|
wxListBox* m_libList; // The list of libs
|
|
|
|
int m_libListWidth; // Last width of the window
|
|
|
|
|
|
|
|
// List of components in the selected library
|
|
|
|
wxListBox* m_cmpList; // The list of components
|
|
|
|
int m_cmpListWidth; // Last width of the window
|
|
|
|
|
2015-04-16 15:26:51 +00:00
|
|
|
// Filters to build list of libs/list of parts
|
|
|
|
bool m_listPowerCmpOnly;
|
|
|
|
wxArrayString m_allowedLibs;
|
|
|
|
|
2014-02-24 10:52:08 +00:00
|
|
|
wxString m_configPath; // subpath for configuration
|
|
|
|
|
|
|
|
// TODO(hzeller): looks like these members were chosen to be static to survive different
|
|
|
|
// instances of this browser and communicate it to the next instance. This looks like an
|
|
|
|
// ugly hack, and should be solved differently.
|
|
|
|
static wxString m_libraryName;
|
|
|
|
|
|
|
|
static wxString m_entryName;
|
Modular-Kicad milestone B), major portions:
*) Rework the set language support, simplify it by using KIWAY. Now any major
frame with a "change language" menu can change the language for all KIWAY_PLAYERs
in the whole KIWAY. Multiple KIWAYs are not supported yet.
*) Simplify "modal wxFrame" support, and add that support exclusively to
KIWAY_PLAYER where it is inherited by all derivatives. The function
KIWAY_PLAYER::ShowModal() is in the vtable and so is cross module capable.
*) Remove the requirements and assumptions that the wxFrame hierarchy always
had PCB_EDIT_FRAME and SCH_EDIT_FRAME as immediate parents of their viewers
and editors. This is no longer the case, nor required.
*) Use KIWAY::Player() everywhere to make KIWAY_PLAYERs, this registers the
KIWAY_PLAYER within the KIWAY and makes it very easy to find an open frame
quickly. It also gives control to the KIWAY as to frame hierarchical
relationships.
*) Change single_top to use the KIWAY for loading a KIFACE and instantiating
the single KIWAY_PLAYER, see bullet immediately above.
*) Add KIWAY::OnKiwayEnd() and call it from PGM_BASE at program termination, this
gives the KIFACEs a chance to save their final configuration dope to disk.
*) Add dedicated FRAME_T's for the modal frames, so m_Ident can be tested and
these modal frames are distinctly different than their non-modal equivalents.
KIWAY_PLAYER::IsModal() is !not! a valid test during the wxFrame's constructor,
so this is another important reason for having a dedicated FRAME_T for each
modal wxFrame.
On balance, more lines were deleted than were added to achieve all this.
2014-05-03 17:40:19 +00:00
|
|
|
|
2014-02-24 10:52:08 +00:00
|
|
|
static int m_unit;
|
|
|
|
static int m_convert;
|
|
|
|
|
2012-09-11 19:03:21 +00:00
|
|
|
DECLARE_EVENT_TABLE()
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // LIBVIEWFRM_H_
|