![]() |
KiCad PCB EDA Suite
|
The main window used in the drawing sheet editor. More...
#include <pl_editor_frame.h>
Public Types | |
enum | UNDO_REDO_LIST { UNDO_LIST, REDO_LIST } |
Specifies whether we are interacting with the undo or redo stacks. More... | |
enum | HOLDER_TYPE { DIALOG, FRAME, PANEL } |
Public Member Functions | |
PL_EDITOR_FRAME (KIWAY *aKiway, wxWindow *aParent) | |
~PL_EDITOR_FRAME () | |
PROPERTIES_FRAME * | GetPropertiesFrame () |
void | ShowDesignInspector () |
Show the dialog displaying the list of DS_DATA_ITEM items in the page layout. More... | |
bool | OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl) override |
Open a project or set of files given by aFileList. More... | |
bool | LoadDrawingSheetFile (const wxString &aFullFileName) |
Load a .kicad_wks drawing sheet file. More... | |
bool | SaveDrawingSheetFile (const wxString &aFullFileName) |
Save the current layout in a .kicad_wks drawing sheet file. More... | |
bool | InsertDrawingSheetFile (const wxString &aFullFileName) |
Load a .kicad_wks drawing sheet file, and add items to the current layout list. More... | |
bool | IsContentModified () const override |
Get if the drawing sheet has been modified but not saved. More... | |
void | OnExit (wxCommandEvent &aEvent) |
Event handler for the wxID_EXIT and wxID_CLOSE events. More... | |
bool | canCloseWindow (wxCloseEvent &aCloseEvent) override |
void | doCloseWindow () override |
void | setupTools () |
void | ReCreateHToolbar () override |
void | UpdateToolbarControlSizes () override |
Update the sizes of any controls in the toolbars of the frame. More... | |
void | SetPageSettings (const PAGE_INFO &) override |
const PAGE_INFO & | GetPageSettings () const override |
const wxSize | GetPageSizeIU () const override |
Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More... | |
PL_DRAW_PANEL_GAL * | GetCanvas () const override |
Return a pointer to GAL-based canvas of given EDA draw frame. More... | |
SELECTION & | GetCurrentSelection () override |
Get the current selection from the canvas area. More... | |
const wxPoint & | GetGridOrigin () const override |
Return the absolute coordinates of the origin of the snap grid. More... | |
void | SetGridOrigin (const wxPoint &aPoint) override |
wxPoint | ReturnCoordOriginCorner () const |
Calculate the position (in page, in iu) of the corner used as coordinate origin of items. More... | |
const TITLE_BLOCK & | GetTitleBlock () const override |
void | SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override |
void | CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override |
Notification event that some of the common (suite-wide) settings have changed. More... | |
void | DisplayGridMsg () override |
Display current grid size in the status bar. More... | |
void | UpdateStatusBar () override |
Update the status bar information. More... | |
void | OnNewDrawingSheet () |
Must be called to initialize parameters when a new drawing sheet is loaded. More... | |
void | ReCreateVToolbar () override |
Create or update the right vertical toolbar. More... | |
void | ReCreateOptToolbar () override |
Create or update the left vertical toolbar. More... | |
void | ReCreateMenuBar () override |
Recreates the menu bar. More... | |
const PL_EDITOR_LAYOUT & | GetPageLayout () const |
PL_EDITOR_LAYOUT & | GetPageLayout () |
const BOX2I | GetDocumentExtents (bool aIncludeAllVisible=true) const override |
Returns bbox of document with option to not include some items. More... | |
bool | GetPageNumberOption () const |
Drawing sheet editor can show the title block using a page number 1 or another number. More... | |
void | UpdateTitleAndInfo () |
Display the short filename (if exists) loaded file on the caption of the main window. More... | |
void | InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override |
Allow a frame to load its preference panels (if any) into the preferences dialog. More... | |
void | LoadSettings (APP_SETTINGS_BASE *aCfg) override |
Load common frame parameters from a configuration file. More... | |
void | SaveSettings (APP_SETTINGS_BASE *aCfg) override |
Save common frame parameters to a configuration data file. More... | |
void | OnSelectPage (wxCommandEvent &event) |
void | OnSelectCoordOriginCorner (wxCommandEvent &event) |
Called when the user select one of the 4 page corner as corner reference (or the left top paper corner). More... | |
void | OnSelectTitleBlockDisplayMode (wxCommandEvent &event) |
Toggle the display mode between the normal mode and the editor mode: In normal mode, title block texts are shown like they will be shown in other kicad applications: the format symbols in texts are replaced by the actual text. More... | |
void | ToPrinter (bool doPreview) |
Open a dialog frame to print layers. More... | |
void | Files_io (wxCommandEvent &event) |
virtual void | PrintPage (const RENDER_SETTINGS *aSettings) override |
Print a page. More... | |
void | OnFileHistory (wxCommandEvent &event) |
void | OnClearFileHistory (wxCommandEvent &aEvent) |
wxString | GetCurrentFileName () const override |
void | SetCurrentFileName (const wxString &aName) |
Store the current layout description file filename. More... | |
void | HardRedraw () override |
Refresh the library tree and redraw the window. More... | |
DS_DATA_ITEM * | AddDrawingSheetItem (int aType) |
Add a new item to the drawing sheet item list. More... | |
void | OnModify () |
Must be called after a change in order to set the "modify" flag. More... | |
void | SaveCopyInUndoList () |
Save a copy of the description (in a S expr string) for Undo/redo commands. More... | |
void | GetLayoutFromRedoList () |
Redo the last edit: More... | |
void | GetLayoutFromUndoList () |
Undo the last edit: More... | |
void | RollbackFromUndo () |
Apply the last command in Undo List without stacking a Redo. More... | |
void | ClearUndoORRedoList (UNDO_REDO_LIST whichList, int aItemCount=-1) override |
Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. More... | |
bool | LockFile (const wxString &aFileName) |
Mark a schematic file as being in use. More... | |
void | ReleaseFile () |
Release the current file marked in use. More... | |
void | ScriptingConsoleEnableDisable () |
Toggles the scripting console visibility. More... | |
bool | IsScriptingConsoleVisible () |
Gets the current visibility of the scripting console window. More... | |
wxFindReplaceData & | GetFindReplaceData () |
wxArrayString & | GetFindHistoryList () |
bool | GetShowPolarCoords () const |
For those frames that support polar coordinates. More... | |
void | SetShowPolarCoords (bool aShow) |
void | ToggleUserUnits () override |
void | GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits) |
Get the pair or units in current use. More... | |
wxPoint | GetNearestGridPosition (const wxPoint &aPosition) const |
Return the nearest aGridSize location to aPosition. More... | |
wxPoint | GetNearestHalfGridPosition (const wxPoint &aPosition) const |
Return the nearest aGridSize / 2 location to aPosition. More... | |
virtual ORIGIN_TRANSFORMS & | GetOriginTransforms () |
Return a reference to the default ORIGIN_TRANSFORMS object. More... | |
virtual COLOR4D | GetDrawBgColor () const |
virtual void | SetDrawBgColor (const COLOR4D &aColor) |
virtual COLOR_SETTINGS * | GetColorSettings () const |
Returns a pointer to the active color theme settings. More... | |
bool | ShowPageLimits () const |
void | SetShowPageLimits (bool aShow) |
bool | LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString) |
virtual wxString | GetScreenDesc () const |
virtual BASE_SCREEN * | GetScreen () const |
Return a pointer to a BASE_SCREEN or one of its derivatives. More... | |
void | EraseMsgBox () |
virtual void | ReCreateAuxiliaryToolbar () |
bool | IsGridVisible () const |
virtual void | SetGridVisibility (bool aVisible) |
virtual COLOR4D | GetGridColor () |
virtual void | SetGridColor (const COLOR4D &aColor) |
void | OnSelectGrid (wxCommandEvent &event) |
Command event handler for selecting grid sizes. More... | |
void | OnGridSettings (wxCommandEvent &event) |
void | UpdateGridSelectBox () |
Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.). More... | |
void | OnUpdateSelectGrid (wxUpdateUIEvent &aEvent) |
Update the checked item in the grid combobox. More... | |
void | UpdateZoomSelectBox () |
Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More... | |
const wxString | GetZoomLevelIndicator () const |
Return a human readable value for display in dialogs. More... | |
virtual void | OnSelectZoom (wxCommandEvent &event) |
Set the zoom factor when selected by the zoom list box in the main tool bar. More... | |
virtual void | OnSize (wxSizeEvent &event) override |
Recalculate the size of toolbars and display panel when the frame size changes. More... | |
void | OnMove (wxMoveEvent &aEvent) override |
virtual void | Zoom_Automatique (bool aWarpPointer) |
Redraw the screen with best zoom level and the best centering that shows all the page or the board. More... | |
void | FocusOnLocation (const wxPoint &aPos) |
Useful to focus on a particular location, in find functions. More... | |
void | AddStandardSubMenus (TOOL_MENU &aMenu) |
Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g. More... | |
void | PrintDrawingSheet (const RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString) |
Prints the drawing-sheet (frame and title block). More... | |
void | DisplayToolMsg (const wxString &msg) override |
void | DisplayConstraintsMsg (const wxString &msg) |
virtual void | OnPageSettingsChange () |
Called when modifying the page settings. More... | |
void | DisplayUnitsMsg () |
Display current unit pane in the status bar. More... | |
void | AppendMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6) |
Append a message to the message panel. More... | |
virtual void | ClearMsgPanel () |
Clear all messages from the message panel. More... | |
void | SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList) |
Clear the message panel and populates it with the contents of aList. More... | |
void | SetMsgPanel (EDA_ITEM *aItem) |
void | SetMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6) |
Helper function that erases the msg panel and then appends a single message. More... | |
virtual void | UpdateMsgPanel () |
Redraw the message panel. More... | |
virtual EDA_ITEM * | GetItem (const KIID &aId) const |
Fetch an item by KIID. More... | |
virtual void | ActivateGalCanvas () |
Use to start up the GAL drawing canvas. More... | |
virtual void | SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) |
Changes the current rendering backend. More... | |
void | SetCanvas (EDA_DRAW_PANEL_GAL *aPanel) |
wxWindow * | GetToolCanvas () const override |
Canvas access. More... | |
KIGFX::GAL_DISPLAY_OPTIONS & | GetGalDisplayOptions () |
Return a reference to the gal rendering options used by GAL for rendering. More... | |
void | RefreshCanvas () override |
void | RecreateToolbars () |
Rebuild all toolbars, and update the checked state of check tools. More... | |
virtual void | ParseArgs (wxCmdLineParser &aParser) |
Handle command-line arguments in a frame-specific way. More... | |
virtual bool | ShowModal (wxString *aResult=nullptr, wxWindow *aResultantFocusWindow=nullptr) |
Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More... | |
virtual void | KiwayMailIn (KIWAY_EXPRESS &aEvent) |
Receive KIWAY_EXPRESS messages from other players. More... | |
bool | Destroy () override |
Our version of Destroy() which is virtual from wxWidgets. More... | |
bool | IsModal () const override |
Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame. More... | |
void | SetModal (bool aIsModal) |
bool | IsDismissed () |
void | DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString) |
void | CreateServer (int service, bool local=true) |
void | OnSockRequest (wxSocketEvent &evt) |
void | OnSockRequestServer (wxSocketEvent &evt) |
virtual void | ExecuteRemoteCommand (const char *cmdline) |
Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). More... | |
EDA_UNITS | GetUserUnits () const |
Return the user units currently in use. More... | |
void | SetUserUnits (EDA_UNITS aUnits) |
void | ChangeUserUnits (EDA_UNITS aUnits) |
SETTINGS_MANAGER * | GetSettingsManager () const |
virtual SEVERITY | GetSeverity (int aErrorCode) const |
bool | ProcessEvent (wxEvent &aEvent) override |
Override the default process event handler to implement the auto save feature. More... | |
virtual void | OnCharHook (wxKeyEvent &aKeyEvent) |
Capture the key event before it is sent to the GUI. More... | |
void | OnMenuEvent (wxMenuEvent &event) |
The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More... | |
virtual void | RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override |
Register a UI update handler for the control with ID aID . More... | |
virtual void | RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions) |
Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More... | |
virtual void | UnregisterUIUpdateHandler (int aID) override |
Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler . More... | |
virtual void | UnregisterUIUpdateHandler (const TOOL_ACTION &aAction) |
Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler . More... | |
void | OnMaximize (wxMaximizeEvent &aEvent) |
void | SetAutoSaveInterval (int aInterval) |
int | GetAutoSaveInterval () const |
bool | IsType (FRAME_T aType) const |
FRAME_T | GetFrameType () const |
virtual const SEARCH_STACK & | sys_search () |
Return a SEARCH_STACK pertaining to entire program. More... | |
virtual wxString | help_name () |
void | OnKicadAbout (wxCommandEvent &event) |
void | OnPreferences (wxCommandEvent &event) |
Displays the preferences and settings of all opened editors paged dialog. More... | |
void | PrintMsg (const wxString &text) |
void | CreateInfoBar () |
void | FinishAUIInitialization () |
WX_INFOBAR * | GetInfoBar () |
void | ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC) |
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More... | |
void | ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback) |
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More... | |
void | ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false) |
Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More... | |
void | ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false) |
Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More... | |
virtual APP_SETTINGS_BASE * | config () const |
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More... | |
void | LoadWindowState (const wxString &aFileName) |
virtual void | LoadWindowState (const WINDOW_STATE &aState) |
Load frame state info from a configuration file. More... | |
void | LoadWindowSettings (const WINDOW_SETTINGS *aCfg) |
Load window settings from the given settings object. More... | |
void | SaveWindowSettings (WINDOW_SETTINGS *aCfg) |
Save window settings to the given settings object. More... | |
virtual WINDOW_SETTINGS * | GetWindowSettings (APP_SETTINGS_BASE *aCfg) |
Return a pointer to the window settings for this frame. More... | |
wxString | ConfigBaseName () override |
Get the configuration base name. More... | |
virtual void | SaveProjectSettings () |
Save changes to the project settings to the project (.pro) file. More... | |
void | ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname) |
Prompt the user for a hotkey file to read, and read it. More... | |
wxString | GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr) |
Fetches the file name from the file history list. More... | |
void | ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr) |
Removes all files from the file history. More... | |
void | UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr) |
Update the list of recently opened files. More... | |
FILE_HISTORY & | GetFileHistory () |
Get the frame's main file history. More... | |
void | SetMruPath (const wxString &aPath) |
wxString | GetMruPath () const |
void | AddStandardHelpMenu (wxMenuBar *aMenuBar) |
Adds the standard KiCad help menu to the menubar. More... | |
bool | IsWritable (const wxFileName &aFileName, bool aVerbose=true) |
Checks if aFileName can be written. More... | |
virtual void | CheckForAutoSaveFile (const wxFileName &aFileName) |
Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More... | |
void | ShowChangedLanguage () override |
Redraw the menus and what not in current language. More... | |
virtual void | ThemeChanged () |
Process light/dark theme change. More... | |
virtual void | ProjectChanged () |
Notification event that the project has changed. More... | |
const wxString & | GetAboutTitle () const |
wxSize | GetWindowSize () |
Get the undecorated window size that can be used for restoring the window size. More... | |
virtual void | ClearUndoRedoList () |
Clear the undo and redo list using ClearUndoORRedoList() More... | |
virtual void | PushCommandToUndoList (PICKED_ITEMS_LIST *aItem) |
Add a command to undo in the undo list. More... | |
virtual void | PushCommandToRedoList (PICKED_ITEMS_LIST *aItem) |
Add a command to redo in the redo list. More... | |
virtual PICKED_ITEMS_LIST * | PopCommandFromUndoList () |
Return the last command to undo and remove it from list, nothing is deleted. More... | |
virtual PICKED_ITEMS_LIST * | PopCommandFromRedoList () |
Return the last command to undo and remove it from list, nothing is deleted. More... | |
virtual int | GetUndoCommandCount () const |
virtual int | GetRedoCommandCount () const |
int | GetMaxUndoItems () const |
bool | NonUserClose (bool aForce) |
virtual void | HandleSystemColorChange () |
Update the UI in response to a change in the system colors. More... | |
TOOL_MANAGER * | GetToolManager () const |
Return the MVC controller. More... | |
virtual void | PushTool (const std::string &actionName) |
NB: the definition of "tool" is different at the user level. More... | |
virtual void | PopTool (const std::string &actionName) |
bool | ToolStackIsEmpty () |
std::string | CurrentToolName () const |
bool | IsCurrentTool (const TOOL_ACTION &aAction) const |
bool | GetDoImmediateActions () const |
Indicate that hotkeys should perform an immediate action even if another tool is currently active. More... | |
MOUSE_DRAG_ACTION | GetDragAction () const |
Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More... | |
bool | GetMoveWarpsCursor () const |
Indicate that a move operation should warp the mouse pointer to the origin of the move object. More... | |
HOLDER_TYPE | GetType () const |
KIWAY & | Kiway () const |
Return a reference to the KIWAY that this object has an opportunity to participate in. More... | |
PROJECT & | Prj () const |
Return a reference to the PROJECT associated with this KIWAY. More... | |
void | SetKiway (wxWindow *aDest, KIWAY *aKiway) |
It is only used for debugging, since "this" is not a wxWindow*. More... | |
Static Public Member Functions | |
static void | HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond) |
Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g. More... | |
Protected Member Functions | |
bool | saveCurrentPageLayout () |
void | setupUIConditions () override |
Setup the UI conditions for the various actions and their controls in this frame. More... | |
DECLARE_EVENT_TABLE () | |
virtual void | SetScreen (BASE_SCREEN *aScreen) |
void | unitsChangeRefresh () override |
Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More... | |
void | setupUnits (APP_SETTINGS_BASE *aCfg) |
std::vector< wxWindow * > | findDialogs () |
void | resolveCanvasType () |
Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More... | |
EDA_DRAW_PANEL_GAL::GAL_TYPE | loadCanvasTypeSetting () |
Returns the canvas type stored in the application settings. More... | |
bool | saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) |
Stores the canvas type in the application settings. More... | |
virtual void | handleActivateEvent (wxActivateEvent &aEvent) |
Handle a window activation event. More... | |
void | onActivate (wxActivateEvent &aEvent) |
void | kiway_express (KIWAY_EXPRESS &aEvent) |
event handler, routes to derivative specific virtual KiwayMailIn() More... | |
void | language_change (wxCommandEvent &event) |
An event handler called on a language menu selection. More... | |
void | onAutoSaveTimer (wxTimerEvent &aEvent) |
Handle the auto save timer event. More... | |
virtual bool | isAutoSaveRequired () const |
Return the auto save status of the application. More... | |
virtual bool | doAutoSave () |
This should be overridden by the derived class to handle the auto save feature. More... | |
void | onSystemColorChange (wxSysColourChangedEvent &aEvent) |
void | initExitKey () |
Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More... | |
void | ensureWindowIsOnScreen () |
Static Protected Member Functions | |
static wxString | GetAutoSaveFilePrefix () |
Static Protected Attributes | |
static constexpr int | KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND |
< Default style flags used for wxAUI toolbars. More... | |
Private Attributes | |
PL_EDITOR_LAYOUT | m_pageLayout |
int | m_propertiesFrameWidth |
wxChoice * | m_originSelectBox |
int | m_originSelectChoice |
wxChoice * | m_pageSelectBox |
wxString | m_mruImagePath |
wxPoint | m_grid_origin |
The main window used in the drawing sheet editor.
Definition at line 45 of file pl_editor_frame.h.
|
inherited |
Enumerator | |
---|---|
DIALOG | |
FRAME | |
PANEL |
Definition at line 39 of file kiway_holder.h.
|
inherited |
Specifies whether we are interacting with the undo or redo stacks.
Enumerator | |
---|---|
UNDO_LIST | |
REDO_LIST |
Definition at line 109 of file eda_base_frame.h.
PL_EDITOR_FRAME::PL_EDITOR_FRAME | ( | KIWAY * | aKiway, |
wxWindow * | aParent | ||
) |
Definition at line 84 of file pl_editor_frame.cpp.
References _, DS_DATA_MODEL::AllowVoidList(), arrayDim(), PCAD2KICAD::Center, DS_DATA_MODEL::ClearList(), config, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, KIUI::GetTextSize(), DS_DATA_MODEL::GetTheInstance(), icon_pagelayout_editor, icon_pagelayout_editor_16, icon_pagelayout_editor_32, KiBitmap(), PCAD2KICAD::Left, DS_DATA_MODEL::LoadDrawingSheet(), DS_DATA_MODEL::m_EditMode, MILLIMETRES, and PCAD2KICAD::Right.
PL_EDITOR_FRAME::~PL_EDITOR_FRAME | ( | ) |
Definition at line 229 of file pl_editor_frame.cpp.
References EDA_DRAW_PANEL_GAL::GetBackend(), GetCanvas(), EDA_DRAW_FRAME::m_canvasType, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::ShutdownAllTools().
|
virtualinherited |
Use to start up the GAL drawing canvas.
Reimplemented in PCB_BASE_FRAME, GERBVIEW_FRAME, PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_BASE_EDIT_FRAME.
Definition at line 707 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::GetCanvas(), and EDA_DRAW_PANEL_GAL::StartDrawing().
Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), SCH_BASE_FRAME::createCanvas(), SCH_DRAW_PANEL::OnShow(), and EDA_DRAW_FRAME::SwitchCanvas().
DS_DATA_ITEM * PL_EDITOR_FRAME::AddDrawingSheetItem | ( | int | aType | ) |
Add a new item to the drawing sheet item list.
aType | is the type of item: DS_TEXT, DS_SEGMENT, DS_RECT, DS_POLYPOLYGON |
aIdx | is the position in list to insert the new item. |
Definition at line 829 of file pl_editor_frame.cpp.
References _, DS_DATA_MODEL::Append(), DS_DATA_ITEM::DS_BITMAP, DS_DATA_ITEM::DS_POLYPOLYGON, DS_DATA_ITEM::DS_RECT, DS_DATA_ITEM::DS_SEGMENT, DS_DATA_ITEM::DS_TEXT, GetCanvas(), DS_DATA_MODEL::GetTheInstance(), image, IU_PER_MILS, m_mruImagePath, and DS_DATA_ITEM::SyncDrawItems().
Referenced by PL_DRAWING_TOOLS::DrawShape(), and PL_DRAWING_TOOLS::PlaceItem().
|
inherited |
Adds the standard KiCad help menu to the menubar.
Definition at line 460 of file eda_base_frame.cpp.
References _, about, ACTIONS::donate, ACTIONS::getInvolved, ACTIONS::gettingStarted, TOOL_MANAGER::GetTool(), ACTIONS::help, ACTIONS::listHotKeys, TOOLS_HOLDER::m_toolManager, and ACTIONS::reportBug.
Referenced by EDA_3D_VIEWER_FRAME::CreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().
|
inherited |
Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g.
zoom and grid).
Definition at line 492 of file eda_draw_frame.cpp.
References CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::AddSubMenu(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, and SELECTION_CONDITIONS::ShowAlways().
Referenced by ROUTER_TOOL::Init(), PL_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PCB_VIEWER_TOOLS::Init(), PL_SELECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), PCB_SELECTION_TOOL::Init(), and PICKER_TOOL::Init().
|
inherited |
Append a message to the message panel.
This helper method checks to make sure the message panel exists in the frame and appends a message to it using the message panel AppendMessage() method.
aTextUpper | The message upper text. |
aTextLower | The message lower text. |
aPadding | Number of spaces to pad between messages. |
Definition at line 652 of file eda_draw_frame.cpp.
References EDA_MSG_PANEL::AppendMessage(), and EDA_DRAW_FRAME::m_messagePanel.
Referenced by GERBER_FILE_IMAGE::DisplayImageInfo(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), and SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo().
|
overridevirtual |
Reimplemented from EDA_BASE_FRAME.
Definition at line 368 of file pl_editor_frame.cpp.
References _, Format(), GetCurrentFileName(), HandleUnsavedChanges(), IsContentModified(), saveCurrentPageLayout(), and KIPLATFORM::APP::SupportsShutdownBlockReason().
|
inherited |
Definition at line 1203 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::SetUserUnits(), and EDA_BASE_FRAME::unitsChangeRefresh().
Referenced by COMMON_TOOLS::SwitchUnits(), and COMMON_TOOLS::ToggleUnits().
|
virtualinherited |
Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input.
If an auto save file exists for aFileName, the user is prompted if they wish to replace file aFileName with the auto saved file. If the user chooses to replace the file, the backup file of aFileName is removed, aFileName is renamed to the backup file name, and the auto save file is renamed to aFileName. If user chooses to keep the existing version of aFileName, the auto save file is removed.
aFileName | A wxFileName object containing the file name to check. |
Reimplemented in SCH_EDIT_FRAME.
Definition at line 1091 of file eda_base_frame.cpp.
References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), Pgm(), and traceAutoSave.
Referenced by PCB_EDIT_FRAME::OpenProjectFiles().
|
inherited |
Removes all files from the file history.
aFileHistory | The FILE_HISTORY in use. If null, the main application file history is used |
Definition at line 976 of file eda_base_frame.cpp.
References FILE_HISTORY::ClearFileHistory(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().
Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), SCH_EDIT_FRAME::OnClearFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), and GERBVIEW_FRAME::OnClearZipFileHistory().
|
virtualinherited |
Clear all messages from the message panel.
Reimplemented in SYMBOL_EDIT_FRAME.
Definition at line 660 of file eda_draw_frame.cpp.
References EDA_MSG_PANEL::EraseMsgBox(), and EDA_DRAW_FRAME::m_messagePanel.
Referenced by GERBVIEW_CONTROL::ClearAllLayers(), GERBVIEW_CONTROL::ClearLayer(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GENDRILL::GenDrillAndMapFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), DIALOG_BOM::OnRunGenerator(), GERBVIEW_CONTROL::ReloadAllLayers(), NETLIST_DIALOG::TransferDataFromWindow(), EE_INSPECTION_TOOL::UpdateMessagePanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo(), and GERBVIEW_FRAME::UpdateTitleAndInfo().
|
overridevirtual |
Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.
Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN. Commands are deleted from the older to the last.
aList | = the UNDO_REDO_CONTAINER of commands. |
aItemCount | number of old commands to delete. -1 to remove all old commands this will empty the list of commands. |
Reimplemented from EDA_BASE_FRAME.
Definition at line 920 of file pl_editor_frame.cpp.
References PICKED_ITEMS_LIST::ClearListAndDeleteItems(), UNDO_REDO_CONTAINER::m_CommandsList, EDA_BASE_FRAME::m_redoList, EDA_BASE_FRAME::m_undoList, and EDA_BASE_FRAME::UNDO_LIST.
Referenced by SaveCopyInUndoList().
|
virtualinherited |
Clear the undo and redo list using ClearUndoORRedoList()
Picked items are deleted by ClearUndoORRedoList() according to their status.
Definition at line 1154 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::REDO_LIST, and EDA_BASE_FRAME::UNDO_LIST.
Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_EDIT_FRAME::emptyScreen(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SCH_EDIT_FRAME::OnImportProject(), OnNewDrawingSheet(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and EDA_BASE_FRAME::~EDA_BASE_FRAME().
|
overridevirtual |
Notification event that some of the common (suite-wide) settings have changed.
Update menus, toolbars, local variables, etc.
Reimplemented from EDA_DRAW_FRAME.
Definition at line 618 of file pl_editor_frame.cpp.
References KIGFX::COLOR, EDA_DRAW_FRAME::CommonSettingsChanged(), SETTINGS_MANAGER::GetAppSettings(), GetCanvas(), SETTINGS_MANAGER::GetColorSettings(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::GetView(), KIGFX::RENDER_SETTINGS::LoadColors(), APP_SETTINGS_BASE::m_ColorTheme, Pgm(), EDA_DRAW_FRAME::RecreateToolbars(), EDA_DRAW_PANEL_GAL::Refresh(), and KIGFX::VIEW::UpdateAllItems().
|
virtualinherited |
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
Reimplemented in SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.
Definition at line 816 of file eda_base_frame.cpp.
References Kiface(), and KIFACE_BASE::KifaceSettings().
Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), and BM2CMP_FRAME::~BM2CMP_FRAME().
|
inlineoverridevirtualinherited |
Get the configuration base name.
This is usually the name of the frame set by CTOR, except for frames shown in multiple modes in which case the m_configName must be set to the base name so that a single configuration can be used.
Reimplemented from TOOLS_HOLDER.
Definition at line 358 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_configName.
Referenced by EDA_BASE_FRAME::SaveWindowSettings().
|
inherited |
Definition at line 841 of file eda_base_frame.cpp.
References TOOLS_HOLDER::GetToolCanvas(), EDA_BASE_FRAME::m_auimgr, and EDA_BASE_FRAME::m_infoBar.
|
inherited |
Definition at line 43 of file eda_dde.cpp.
References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and KIWAY_PLAYER::m_socketServer.
Referenced by SCH::IFACE::CreateWindow().
|
inherited |
Definition at line 100 of file tools_holder.cpp.
References TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.
Referenced by TOOL_MANAGER::processEvent(), and TOOLS_HOLDER::ShowChangedLanguage().
|
protected |
|
overrideinherited |
Our version of Destroy() which is virtual from wxWidgets.
Definition at line 154 of file kiway_player.cpp.
Referenced by DISPLAY_FOOTPRINTS_FRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().
|
inherited |
Definition at line 166 of file kiway_player.cpp.
References KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_ret_val, and KIWAY_PLAYER::m_modal_string.
Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), and SYMBOL_VIEWER_FRAME::FinishModal().
|
inherited |
Definition at line 518 of file eda_draw_frame.cpp.
Referenced by DRAWING_TOOL::updateStatusBar().
|
overridevirtual |
Display current grid size in the status bar.
Reimplemented from EDA_DRAW_FRAME.
Definition at line 677 of file pl_editor_frame.cpp.
References GetCanvas(), grid, INCHES, EDA_BASE_FRAME::m_userUnits, MILLIMETRES, and To_User_Unit().
Referenced by UpdateStatusBar().
|
overridevirtualinherited |
Reimplemented from TOOLS_HOLDER.
Definition at line 512 of file eda_draw_frame.cpp.
Referenced by EDIT_TOOL::Duplicate(), and PCB_CONTROL::Paste().
|
inherited |
Display current unit pane in the status bar.
Definition at line 536 of file eda_draw_frame.cpp.
References _, INCHES, EDA_BASE_FRAME::m_userUnits, MILLIMETRES, and MILS.
Referenced by EDA_DRAW_FRAME::UpdateGridSelectBox(), SCH_BASE_FRAME::UpdateStatusBar(), and EDA_DRAW_FRAME::UpdateStatusBar().
|
protectedvirtualinherited |
This should be overridden by the derived class to handle the auto save feature.
Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.
Definition at line 327 of file eda_base_frame.cpp.
Referenced by EDA_BASE_FRAME::onAutoSaveTimer().
|
overridevirtual |
Reimplemented from EDA_BASE_FRAME.
Definition at line 397 of file pl_editor_frame.cpp.
References DS_DATA_MODEL::ClearList(), KIWAY_PLAYER::Destroy(), DS_DATA_MODEL::GetTheInstance(), and m_propertiesPagelayout.
|
protectedinherited |
Definition at line 657 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.
Referenced by EDA_BASE_FRAME::OnSize().
|
inherited |
Definition at line 305 of file eda_draw_frame.cpp.
References EDA_MSG_PANEL::EraseMsgBox(), and EDA_DRAW_FRAME::m_messagePanel.
Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().
|
inlinevirtualinherited |
Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242).
Subclasses should override to implement actual command handlers.
Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.
Definition at line 196 of file kiway_player.h.
Referenced by KIWAY_PLAYER::OnSockRequest().
void PL_EDITOR_FRAME::Files_io | ( | wxCommandEvent & | event | ) |
Definition at line 95 of file pagelayout_editor/files.cpp.
References _, DS_DATA_MODEL::AllowVoidList(), DS_DATA_MODEL::ClearList(), DisplayErrorMessage(), DrawingSheetFileExtension, DrawingSheetFileWildcard(), GetCurrentFileName(), EDA_DRAW_FRAME::GetScreen(), DS_DATA_MODEL::GetTheInstance(), PATHS::GetUserTemplatesPath(), HandleUnsavedChanges(), HardRedraw(), ID_APPEND_DESCR_FILE, InsertDrawingSheetFile(), IsContentModified(), LoadDrawingSheetFile(), OnNewDrawingSheet(), saveCurrentPageLayout(), SaveDrawingSheetFile(), BASE_SCREEN::SetContentModified(), and SetCurrentFileName().
Referenced by PL_EDIT_TOOL::ImportDrawingSheetContent(), PL_EDITOR_CONTROL::New(), PL_EDITOR_CONTROL::Open(), PL_EDITOR_CONTROL::Save(), PL_EDITOR_CONTROL::SaveAs(), and saveCurrentPageLayout().
|
protectedinherited |
Definition at line 842 of file eda_draw_frame.cpp.
Referenced by PCB_BASE_FRAME::FocusOnItems(), and EDA_DRAW_FRAME::FocusOnLocation().
|
inherited |
|
inherited |
Useful to focus on a particular location, in find functions.
Move the graphic cursor (crosshair cursor) at a given coordinate and reframes the drawing if the requested point is out of view or if center on location is requested.
aPos | is the point to go to. |
Definition at line 856 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::findDialogs(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), KIGFX::VIEW::GetViewport(), r, KIGFX::VIEW::SetCenter(), and KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition().
Referenced by PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindNext(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), and DIALOG_FIND::search().
|
inlineinherited |
Definition at line 514 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_aboutTitle.
Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), PGM_SINGLE_TOP::OnPgmInit(), and COMMON_CONTROL::ReportBug().
|
inlinestaticprotectedinherited |
Definition at line 602 of file eda_base_frame.h.
Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), SCH_EDIT_FRAME::CheckForAutoSaveFile(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveSchematicFile(), and SCH_EDIT_FRAME::updateAutoSaveFile().
|
inlineinherited |
|
overridevirtual |
Return a pointer to GAL-based canvas of given EDA draw frame.
Reimplemented from EDA_DRAW_FRAME.
Definition at line 800 of file pl_editor_frame.cpp.
References EDA_DRAW_FRAME::GetCanvas().
Referenced by AddDrawingSheetItem(), CommonSettingsChanged(), DisplayGridMsg(), PL_SELECTION_TOOL::doSelectionMenu(), PL_DRAWING_TOOLS::DrawShape(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), HardRedraw(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_SELECTION_TOOL::Main(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_INSPECTOR::onCellClicked(), OnNewDrawingSheet(), OnSelectCoordOriginCorner(), OnSelectPage(), PROPERTIES_FRAME::OnSetDefaultValues(), PL_DRAWING_TOOLS::PlaceItem(), PLEDITOR_PRINTOUT::PrintPage(), PrintPage(), RollbackFromUndo(), PL_SELECTION_TOOL::selectMultiple(), PL_POINT_EDITOR::setEditedPoint(), setupTools(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), UpdateStatusBar(), and ~PL_EDITOR_FRAME().
|
virtualinherited |
Returns a pointer to the active color theme settings.
Reimplemented in SCH_BASE_FRAME, SYMBOL_EDIT_FRAME, PCB_BASE_EDIT_FRAME, PCB_BASE_FRAME, FOOTPRINT_VIEWER_FRAME, DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_WIZARD_FRAME.
Definition at line 1040 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::m_colorSettings, and Pgm().
Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), GERBVIEW_CONTROL::Print(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().
|
overridevirtual |
Reimplemented from EDA_BASE_FRAME.
Definition at line 570 of file pl_editor_frame.cpp.
References BASE_SCREEN::m_DrawingSheetFileName.
Referenced by canCloseWindow(), Files_io(), OnNewDrawingSheet(), PL_EDITOR_CONTROL::PageSetup(), and UpdateTitleAndInfo().
|
overridevirtual |
Get the current selection from the canvas area.
Reimplemented from TOOLS_HOLDER.
Definition at line 806 of file pl_editor_frame.cpp.
References TOOL_MANAGER::GetTool(), and TOOLS_HOLDER::m_toolManager.
|
overridevirtual |
Returns bbox of document with option to not include some items.
Used most commonly by "Zoom to Fit" and "Zoom to Objects". In Eeschema for "Zoom to Fit" it's passed "true" to include drawing sheet border, and "false" by "Zoom To Objects" to ignore drawing sheet border. In Pcbnew, false makes it ignore any items outside the PCB edge such as fabrication notes.
aIncludeAllVisible | True to include everything visible in bbox calculations, false to ignore some visible items (program dependent). |
Reimplemented from EDA_DRAW_FRAME.
Definition at line 475 of file pl_editor_frame.cpp.
References GetPageLayout(), and GetPageSettings().
|
inlineinherited |
Indicate that hotkeys should perform an immediate action even if another tool is currently active.
If false, the first hotkey should select the relevant tool.
Definition at line 129 of file tools_holder.h.
References TOOLS_HOLDER::m_immediateActions.
|
inlineinherited |
Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.
Definition at line 135 of file tools_holder.h.
References TOOLS_HOLDER::m_dragAction.
Referenced by PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), and PCB_SELECTION_TOOL::Main().
|
inlinevirtualinherited |
Reimplemented in SCH_BASE_FRAME.
Definition at line 173 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_drawBgColor.
Referenced by GERBVIEW_FRAME::GetNegativeItemsColor(), PLEDITOR_PRINTOUT::PrintPage(), SaveSettings(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().
|
inherited |
Fetches the file name from the file history list.
This removes the selected file, if this file does not exist. The menu is also updated, if #FILE_HISTORY::UseMenu was called at initialization time.
cmdId | The command ID associated with the aFileHistory object. |
type | Please document me! |
aFileHistory | The FILE_HISTORY in use. If null, the main application file history is used |
Definition at line 936 of file eda_base_frame.cpp.
References _, DisplayErrorMessage(), Format(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().
Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), SCH_EDIT_FRAME::OnLoadFile(), and GERBVIEW_FRAME::OnZipFileHistory().
|
inlineinherited |
Get the frame's main file history.
Definition at line 423 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_fileHistory.
Referenced by KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().
|
inlineinherited |
Definition at line 106 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_findStringHistoryList.
Referenced by DIALOG_FIND::DIALOG_FIND(), DIALOG_FIND::search(), DIALOG_SCH_FIND::SetFindEntries(), and DIALOG_SCH_FIND::SetReplaceEntries().
|
inlineinherited |
Definition at line 105 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_findReplaceData.
Referenced by SCH_EDITOR_CONTROL::FindNext(), SCH_EDITOR_CONTROL::HasMatch(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), DIALOG_FIND::search(), and SCH_EDITOR_CONTROL::UpdateFind().
|
inlineinherited |
|
inlineinherited |
Return a reference to the gal rendering options used by GAL for rendering.
Definition at line 427 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_galDisplayOptions.
Referenced by SCH_BASE_FRAME::createCanvas(), EDITOR_CONDITIONS::cursorFunc(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_VIEWER_FRAME::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), DIALOG_PAD_PROPERTIES::prepareCanvas(), FOOTPRINT_EDIT_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), COMMON_TOOLS::ToggleCursor(), and COMMON_TOOLS::ToggleCursorStyle().
|
inlinevirtualinherited |
Reimplemented in GERBVIEW_FRAME, FOOTPRINT_EDIT_FRAME, PCB_EDIT_FRAME, DISPLAY_FOOTPRINTS_FRAME, and FOOTPRINT_VIEWER_FRAME.
Definition at line 227 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_gridColor.
Referenced by PCB_CONTROL::Reset().
|
inlineoverridevirtual |
Return the absolute coordinates of the origin of the snap grid.
This is treated as a relative offset and snapping will occur at multiples of the grid size relative to this point.
Implements EDA_DRAW_FRAME.
Definition at line 110 of file pl_editor_frame.h.
References m_grid_origin.
|
inlineinherited |
Definition at line 234 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_infoBar.
Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), PL_EDIT_TOOL::Main(), SCH_MOVE_TOOL::Main(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), PAD_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SYMBOL_EDIT_FRAME::SetCurSymbol(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), EDA_BASE_FRAME::ShowInfoBarWarning(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and PCB_CONTROL::unfilledZoneCheck().
Fetch an item by KIID.
Frame-type-specific implementation.
Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.
Definition at line 395 of file eda_draw_frame.h.
Referenced by PCB_MARKER::GetMsgPanelInfo(), RC_TREE_MODEL::GetValue(), and EE_SELECTION_TOOL::Main().
void PL_EDITOR_FRAME::GetLayoutFromRedoList | ( | ) |
Redo the last edit:
Definition at line 52 of file pl_editor_undo_redo.cpp.
References PL_SELECTION_TOOL::ClearSelection(), GetCanvas(), ITEM_PICKER::GetItem(), EDA_BASE_FRAME::GetRedoCommandCount(), EDA_DRAW_FRAME::GetScreen(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), HardRedraw(), OnModify(), EDA_BASE_FRAME::PopCommandFromRedoList(), PICKED_ITEMS_LIST::PopItem(), EDA_BASE_FRAME::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), PL_SELECTION_TOOL::RebuildSelection(), EDA_DRAW_PANEL_GAL::Refresh(), DS_PROXY_UNDO_ITEM::Restore(), EDA_ITEM::Type(), and WS_PROXY_UNDO_ITEM_PLUS_T.
Referenced by PL_EDIT_TOOL::Redo().
void PL_EDITOR_FRAME::GetLayoutFromUndoList | ( | ) |
Undo the last edit:
Definition at line 89 of file pl_editor_undo_redo.cpp.
References PL_SELECTION_TOOL::ClearSelection(), GetCanvas(), ITEM_PICKER::GetItem(), EDA_DRAW_FRAME::GetScreen(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), EDA_BASE_FRAME::GetUndoCommandCount(), HardRedraw(), OnModify(), EDA_BASE_FRAME::PopCommandFromUndoList(), PICKED_ITEMS_LIST::PopItem(), EDA_BASE_FRAME::PushCommandToRedoList(), PICKED_ITEMS_LIST::PushItem(), PL_SELECTION_TOOL::RebuildSelection(), EDA_DRAW_PANEL_GAL::Refresh(), DS_PROXY_UNDO_ITEM::Restore(), EDA_ITEM::Type(), and WS_PROXY_UNDO_ITEM_PLUS_T.
Referenced by PL_EDIT_TOOL::Undo().
|
inlineinherited |
Definition at line 582 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_undoRedoCountMax.
Referenced by EDA_DRAW_FRAME::SaveSettings().
|
inlineinherited |
Indicate that a move operation should warp the mouse pointer to the origin of the move object.
This improves snapping, but some users are allergic to mouse warping.
Definition at line 141 of file tools_holder.h.
References TOOLS_HOLDER::m_moveWarpsCursor.
Referenced by EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::InlineDrag(), SYMBOL_EDITOR_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::Main().
|
inlineinherited |
Definition at line 430 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_mruPath.
Referenced by AskLoadBoardFileName(), PANEL_HOTKEYS_EDITOR::dumpHotkeys(), GERBVIEW_CONTROL::ExportToPcbnew(), PCB_EDIT_FRAME::Files_io_from_id(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), EDA_DRAW_FRAME::LibraryFileBrowser(), KICAD_MANAGER_CONTROL::NewProject(), KICAD_MANAGER_CONTROL::OpenProject(), SCH_EDIT_FRAME::SaveProject(), and KICAD_MANAGER_CONTROL::SaveProjectAs().
|
inherited |
Return the nearest aGridSize location to aPosition.
aPosition | The position to check. |
Definition at line 795 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_FRAME::GetGridOrigin(), KIGFX::GAL::GetGridSize(), KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.
Referenced by SCH_DRAWING_TOOLS::sizeSheet().
|
inherited |
Return the nearest aGridSize / 2 location to aPosition.
This is useful when attempting for keep outer points on grid but not the middle point.
aPosition | The position to check. |
Definition at line 809 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_FRAME::GetGridOrigin(), KIGFX::GAL::GetGridSize(), KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.
Referenced by SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Rotate().
|
inlinevirtualinherited |
Return a reference to the default ORIGIN_TRANSFORMS object.
Reimplemented in PCB_BASE_FRAME.
Definition at line 164 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_originTransforms.
Referenced by PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), and EDA_SHAPE::ShapeGetMsgPanelInfo().
|
inline |
Definition at line 147 of file pl_editor_frame.h.
References m_pageLayout.
Referenced by GetDocumentExtents(), GetTitleBlock(), DIALOG_INSPECTOR::ReCreateDesignList(), and PL_EDITOR_CONTROL::UpdateMessagePanel().
|
inline |
bool PL_EDITOR_FRAME::GetPageNumberOption | ( | ) | const |
Drawing sheet editor can show the title block using a page number 1 or another number.
This is because some items can be shown (or not) only on page 1 (a feature which looks like word processing option "page 1 differs from other pages").
Definition at line 945 of file pl_editor_frame.cpp.
References m_pageSelectBox.
Referenced by PrintPage().
|
overridevirtual |
Implements EDA_DRAW_FRAME.
Definition at line 591 of file pl_editor_frame.cpp.
References PL_EDITOR_LAYOUT::GetPageSettings(), and m_pageLayout.
Referenced by GetDocumentExtents(), LoadSettings(), PLEDITOR_PRINTOUT::PrintPage(), SaveSettings(), and ToPrinter().
|
overridevirtual |
Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view.
Implements EDA_DRAW_FRAME.
Definition at line 597 of file pl_editor_frame.cpp.
References PL_EDITOR_LAYOUT::GetPageSettings(), and m_pageLayout.
Referenced by DIALOG_INSPECTOR::ReCreateDesignList().
|
inline |
Definition at line 51 of file pl_editor_frame.h.
References m_propertiesPagelayout.
Referenced by DIALOG_INSPECTOR::onCellClicked(), PL_POINT_EDITOR::updateItem(), and PL_EDITOR_CONTROL::UpdateMessagePanel().
|
inlinevirtualinherited |
Reimplemented in CVPCB_MAINFRAME.
Definition at line 580 of file eda_base_frame.h.
References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_redoList.
Referenced by GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), SCH_EDITOR_CONTROL::Redo(), and EDITOR_CONDITIONS::redoFunc().
|
inlinevirtualinherited |
Return a pointer to a BASE_SCREEN or one of its derivatives.
It is overloaded by derived classes to return SCH_SCREEN or PCB_SCREEN.
Reimplemented in PCB_BASE_FRAME, SCH_EDIT_FRAME, and SCH_BASE_FRAME.
Definition at line 204 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_currentScreen.
Referenced by GERBVIEW_FRAME::Clear_DrawLayers(), EDA_DRAW_PANEL_GAL::DoRePaint(), Files_io(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), SCH_BASE_FRAME::GetScreen(), PCB_BASE_FRAME::GetScreen(), IsContentModified(), LoadDrawingSheetFile(), OnModify(), OnNewDrawingSheet(), PLEDITOR_PRINTOUT::PrintPage(), PrintPage(), COMMON_TOOLS::ResetLocalCoords(), SaveCopyInUndoList(), SaveDrawingSheetFile(), SetPageSettings(), GERBVIEW_FRAME::SetPageSettings(), GERBVIEW_FRAME::UpdateStatusBar(), and UpdateStatusBar().
|
virtualinherited |
Reimplemented in SCH_EDIT_FRAME.
Definition at line 957 of file eda_draw_frame.cpp.
Referenced by KIGFX::SCH_VIEW::DisplaySheet(), and EDA_DRAW_FRAME::PrintDrawingSheet().
|
inlineinherited |
Definition at line 140 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_settingsManager.
Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), GetSettingsManager(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().
|
inlinevirtualinherited |
Reimplemented in PCB_BASE_FRAME, and SCH_EDIT_FRAME.
Definition at line 142 of file eda_base_frame.h.
References RPT_SEVERITY_UNDEFINED.
Referenced by RC_TREE_MODEL::GetValue().
|
inlineinherited |
For those frames that support polar coordinates.
Definition at line 120 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_polarCoords.
Referenced by EDITOR_CONDITIONS::polarCoordFunc(), COMMON_TOOLS::TogglePolarCoords(), GERBVIEW_FRAME::UpdateStatusBar(), and PCB_BASE_FRAME::UpdateStatusBar().
|
overridevirtual |
Implements EDA_DRAW_FRAME.
Definition at line 606 of file pl_editor_frame.cpp.
References GetPageLayout(), and PL_EDITOR_LAYOUT::GetTitleBlock().
|
inlineoverridevirtualinherited |
Canvas access.
Implements TOOLS_HOLDER.
Definition at line 422 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::GetCanvas().
|
inlineinherited |
Return the MVC controller.
Definition at line 54 of file tools_holder.h.
References TOOLS_HOLDER::m_toolManager.
Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextMenu(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), SCH_NAVIGATE_TOOL::HypertextCommand(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), EDA_3D_VIEWER_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME::InstallPreferences(), InstallPreferences(), FOOTPRINT_EDIT_FRAME::InstallPreferences(), SYMBOL_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ABOUT::onDonateClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PANEL_PCBNEW_ACTION_PLUGINS::OnOpenDirectoryButtonClick(), SIM_PLOT_FRAME::onProbe(), PANEL_PCBNEW_ACTION_PLUGINS::OnReloadButtonClick(), DIALOG_ABOUT::onReportBug(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), Refresh(), RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST_IMPORT::~DIALOG_NETLIST_IMPORT(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().
|
inlineinherited |
Definition at line 46 of file kiway_holder.h.
References KIWAY_HOLDER::m_type.
Referenced by DIALOG_SHIM::DIALOG_SHIM().
|
inlinevirtualinherited |
Reimplemented in CVPCB_MAINFRAME.
Definition at line 579 of file eda_base_frame.h.
References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_undoList.
Referenced by GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EDA_BASE_FRAME::PushCommandToUndoList(), RollbackFromUndo(), SCH_EDITOR_CONTROL::Undo(), and EDITOR_CONDITIONS::undoFunc().
|
inherited |
Get the pair or units in current use.
The primary unit is the main unit of the frame, and the secondary unit is the unit of the other system that was used most recently.
Definition at line 1075 of file eda_draw_frame.cpp.
References COMMON_TOOLS::GetLastImperialUnits(), COMMON_TOOLS::GetLastMetricUnits(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::GetUserUnits(), EDA_UNIT_UTILS::IsImperialUnit(), TOOLS_HOLDER::m_toolManager, MILLIMETRES, and MILS.
Referenced by GRID_MENU::BuildChoiceList(), and PCB_EDIT_FRAME::UpdateTrackWidthSelectBox().
|
inlineinherited |
Return the user units currently in use.
Definition at line 126 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_userUnits.
Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), EE_INSPECTION_TOOL::CheckSymbol(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_FP_EDITOR_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), BOARD_INSPECTION_TOOL::getItemDescription(), SCH_PIN::GetMsgPanelInfo(), PL_EDITOR_LAYOUT::GetMsgPanelInfo(), PCB_MARKER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), FP_TEXT_GRID_TABLE::GetValue(), PIN_TABLE_DATA_MODEL::GetValue(), RC_TREE_MODEL::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), FP_TEXT_GRID_TABLE::SetValue(), PIN_TABLE_DATA_MODEL::SetValue(), EDA_SHAPE::ShapeGetMsgPanelInfo(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), PIN_TABLE_DATA_MODEL::SortRows(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), ROUTER_TOOL::UpdateMessagePanel(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), GERBVIEW_FRAME::UpdateStatusBar(), UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), and DRC_TOOL::userUnits().
|
virtualinherited |
Return a pointer to the window settings for this frame.
By default, points to aCfg->m_Window for top-level frames.
aCfg | is this frame's config object |
Reimplemented in FOOTPRINT_WIZARD_FRAME, SIM_PLOT_FRAME, FOOTPRINT_VIEWER_FRAME, SYMBOL_VIEWER_FRAME, and DISPLAY_FOOTPRINTS_FRAME.
Definition at line 810 of file eda_base_frame.cpp.
References APP_SETTINGS_BASE::m_Window.
Referenced by EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::SaveSettings(), and EDA_DRAW_FRAME::SaveSettings().
|
inherited |
Get the undecorated window size that can be used for restoring the window size.
This is needed for GTK, since the normal wxWidgets GetSize() call will return a window size that includes the window decorations added by the window manager.
Definition at line 1237 of file eda_base_frame.cpp.
References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.
Referenced by EDA_BASE_FRAME::ensureWindowIsOnScreen(), EDA_BASE_FRAME::OnMaximize(), and EDA_BASE_FRAME::SaveWindowSettings().
|
inherited |
Return a human readable value for display in dialogs.
Definition at line 574 of file eda_draw_frame.cpp.
References Format(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetZoomFactor(), EDA_DRAW_FRAME::m_canvas, and zoom.
Referenced by UpdateStatusBar(), and EDA_DRAW_FRAME::UpdateStatusBar().
|
protectedvirtualinherited |
Handle a window activation event.
Reimplemented in PCB_BASE_EDIT_FRAME.
Definition at line 1127 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::m_messagePanel.
Referenced by PCB_BASE_EDIT_FRAME::handleActivateEvent(), and EDA_DRAW_FRAME::onActivate().
|
virtualinherited |
Update the UI in response to a change in the system colors.
Definition at line 1261 of file eda_base_frame.cpp.
References GetBitmapStore(), EDA_BASE_FRAME::ReCreateMenuBar(), BITMAP_STORE::ThemeChanged(), and EDA_BASE_FRAME::ThemeChanged().
Referenced by EDA_BASE_FRAME::onSystemColorChange().
|
staticinherited |
Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g.
enabled, checked, etc.).
aEvent | is the wxUpdateUIEvent to be processed. |
aFrame | is the frame to get the selection from |
aCond | are the #UI SELECTION_CONDITIONS used |
Definition at line 376 of file eda_base_frame.cpp.
References ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), TOOL_ACTION::GetUIId(), ACTIONS::paste, and ACTION_CONDITIONS::showCondition.
Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().
|
overridevirtual |
Refresh the library tree and redraw the window.
Reimplemented from EDA_DRAW_FRAME.
Definition at line 812 of file pl_editor_frame.cpp.
References PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), GetCanvas(), PL_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), m_propertiesPagelayout, TOOLS_HOLDER::m_toolManager, and EDA_DRAW_PANEL_GAL::Refresh().
Referenced by Files_io(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), PL_EDITOR_CONTROL::PageSetup(), RollbackFromUndo(), and PL_EDITOR_CONTROL::TitleBlockDisplayMode().
|
virtualinherited |
Reimplemented in KICAD_MANAGER_FRAME.
Definition at line 829 of file eda_base_frame.cpp.
References KIFACE_BASE::GetHelpFileName(), and Kiface().
Referenced by COMMON_CONTROL::ShowHelp().
|
inherited |
Prompt the user for a hotkey file to read, and read it.
aActionMap | current hotkey map (over which the imported hotkeys will be applied). |
aDefaultShortname | a default short name (extension not needed) like Eeschema, KiCad... |
|
protectedinherited |
Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
This is useful in sub-applications to pass the event up to a non-owning window.
Definition at line 1145 of file eda_base_frame.cpp.
bool PL_EDITOR_FRAME::InsertDrawingSheetFile | ( | const wxString & | aFullFileName | ) |
Load a .kicad_wks drawing sheet file, and add items to the current layout list.
aFullFileName | is the filename. |
Definition at line 275 of file pagelayout_editor/files.cpp.
References DS_DATA_MODEL::GetTheInstance(), DS_DATA_MODEL::LoadDrawingSheet(), and SaveCopyInUndoList().
Referenced by Files_io().
|
overridevirtual |
Allow a frame to load its preference panels (if any) into the preferences dialog.
aParent | a paged dialog into which the preference panels should be installed. |
Reimplemented from EDA_BASE_FRAME.
Definition at line 482 of file pl_editor_frame.cpp.
References _, PANEL_HOTKEYS_EDITOR::AddHotKeys(), TOOLS_HOLDER::GetToolManager(), and PAGED_DIALOG::GetTreebook().
|
inlineprotectedvirtualinherited |
Return the auto save status of the application.
Override this function if your derived frame supports automatic file saving.
Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.
Definition at line 617 of file eda_base_frame.h.
Referenced by EDA_BASE_FRAME::ProcessEvent().
|
overridevirtual |
Get if the drawing sheet has been modified but not saved.
Reimplemented from EDA_BASE_FRAME.
Definition at line 352 of file pl_editor_frame.cpp.
References EDA_DRAW_FRAME::GetScreen(), and BASE_SCREEN::IsContentModified().
Referenced by canCloseWindow(), Files_io(), OnFileHistory(), and saveCurrentPageLayout().
|
inherited |
Definition at line 109 of file tools_holder.cpp.
References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.
Referenced by SCH_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().
|
inherited |
Definition at line 160 of file kiway_player.cpp.
References KIWAY_PLAYER::m_modal_loop.
Referenced by SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), and FOOTPRINT_WIZARD_FRAME::doCloseWindow().
|
inherited |
Definition at line 408 of file eda_draw_frame.cpp.
References EDA_BASE_FRAME::config(), WINDOW_SETTINGS::grid, APP_SETTINGS_BASE::m_Window, and GRID_SETTINGS::show.
Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), EDITOR_CONDITIONS::gridFunc(), GERBVIEW_FRAME::IsElementVisible(), PICKER_TOOL::Main(), GERBER_LAYER_WIDGET::OnRenderEnable(), and COMMON_TOOLS::ToggleGrid().
|
inlineoverridevirtualinherited |
Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame.
In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing.
Reimplemented from EDA_BASE_FRAME.
Definition at line 173 of file kiway_player.h.
References KIWAY_PLAYER::m_modal.
Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().
|
inherited |
Gets the current visibility of the scripting console window.
Definition at line 249 of file eda_draw_frame.cpp.
References FRAME_PYTHON, KIWAY_HOLDER::Kiway(), and KIWAY::Player().
Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().
|
inlineinherited |
Definition at line 206 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_ident.
Referenced by SYMBOL_EDITOR_CONTROL::AddLibrary(), PCB_CONTROL::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), CONVERT_TOOL::CreatePolys(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbol(), PCB_EDITOR_CONDITIONS::get45degModeFunc(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), CONVERT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), DIALOG_FIELD_PROPERTIES::init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), EE_INSPECTION_TOOL::ShowERCDialog(), DRAWING_TOOL::ToggleLine45degMode(), SYMBOL_EDITOR_CONTROL::ToggleSymbolTree(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), and DRAWING_TOOL::updateStatusBar().
|
inherited |
Checks if aFileName can be written.
The function performs a number of tests on aFileName to verify that it can be saved. If aFileName defines a path with no file name, them the path is tested for user write permission. If aFileName defines a file name that does not exist in the path, the path is tested for user write permission. If aFileName defines a file that already exits, the file name is tested for user write permissions.
aFileName | The full path and/or file name of the file to test. |
aVerbose | If true will show an error dialog if the file is not writable |
Definition at line 1045 of file eda_base_frame.cpp.
References _.
Referenced by SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProjectSettings(), and SCH_EDIT_FRAME::saveSchematicFile().
|
inlineinherited |
Return a reference to the KIWAY that this object has an opportunity to participate in.
A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.
Definition at line 53 of file kiway_holder.h.
References KIWAY_HOLDER::m_kiway.
Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AskToSaveChanges(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), SYMBOL_EDIT_FRAME::saveCurrentSymbol(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().
|
protectedinherited |
event handler, routes to derivative specific virtual KiwayMailIn()
Definition at line 181 of file kiway_player.cpp.
References KIWAY_PLAYER::KiwayMailIn().
|
virtualinherited |
Receive KIWAY_EXPRESS messages from other players.
Override it in derived classes.
Reimplemented in SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, SCH_EDIT_FRAME, PCB_EDIT_FRAME, and CVPCB_MAINFRAME.
Definition at line 71 of file kiway_player.cpp.
Referenced by KIWAY_PLAYER::kiway_express(), and KIWAY::ProcessEvent().
|
protectedinherited |
An event handler called on a language menu selection.
Definition at line 188 of file kiway_player.cpp.
References KIWAY_HOLDER::Kiway(), and KIWAY::SetLanguage().
|
inherited |
doOpen | if true runs an Open Library browser, otherwise New Library |
aFilename | for New may contain a default name; in both cases return the chosen filename. |
wildcard | a wildcard to filter the displayed files |
ext | the library file extension |
isDirectory | indicates the library files are directories |
Definition at line 964 of file eda_draw_frame.cpp.
References _, EDA_BASE_FRAME::GetMruPath(), PROJECT::GetProjectPath(), PROJECT::IsNullProject(), KIWAY_HOLDER::Prj(), and EDA_BASE_FRAME::SetMruPath().
Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), and PCB_BASE_EDIT_FRAME::createNewLibrary().
|
protectedinherited |
Returns the canvas type stored in the application settings.
Definition at line 723 of file eda_draw_frame.cpp.
References APP_SETTINGS_BASE::GRAPHICS::canvas_type, EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, Kiface(), KIFACE_BASE::KifaceSettings(), and APP_SETTINGS_BASE::m_Graphics.
Referenced by SCH_BASE_FRAME::createCanvas(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), and EDA_DRAW_FRAME::resolveCanvasType().
bool PL_EDITOR_FRAME::LoadDrawingSheetFile | ( | const wxString & | aFullFileName | ) |
Load a .kicad_wks drawing sheet file.
aFullFileName | is the filename. |
Definition at line 233 of file pagelayout_editor/files.cpp.
References _, WX_INFOBAR::AddCloseButton(), WX_INFOBAR::Dismiss(), EDA_DRAW_FRAME::GetScreen(), DS_DATA_MODEL::GetTheInstance(), DS_DATA_MODEL::LoadDrawingSheet(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::OUTDATED_SAVE, WX_INFOBAR::RemoveAllButtons(), BASE_SCREEN::SetContentModified(), SetCurrentFileName(), SEXPR_WORKSHEET_FILE_VERSION, EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarWarning(), WX_INFOBAR::ShowMessage(), and EDA_BASE_FRAME::UpdateFileHistory().
Referenced by Files_io(), OnFileHistory(), and OpenProjectFiles().
|
overridevirtual |
Load common frame parameters from a configuration file.
Don't forget to call the base method or your frames won't remember their positions and sizes.
Reimplemented from EDA_DRAW_FRAME.
Definition at line 496 of file pl_editor_frame.cpp.
References BLACK, GetPageSettings(), WINDOW_SETTINGS::grid, EDA_DRAW_FRAME::LoadSettings(), PL_EDITOR_SETTINGS::m_BlackBackground, PL_EDITOR_SETTINGS::m_CornerOrigin, PL_EDITOR_SETTINGS::m_LastCustomHeight, PL_EDITOR_SETTINGS::m_LastCustomWidth, PL_EDITOR_SETTINGS::m_LastPaperSize, PL_EDITOR_SETTINGS::m_LastWasPortrait, m_originSelectChoice, PL_EDITOR_SETTINGS::m_PropertiesFrameWidth, m_propertiesFrameWidth, APP_SETTINGS_BASE::m_Window, PAGE_INFO::SetCustomHeightMils(), PAGE_INFO::SetCustomWidthMils(), EDA_DRAW_FRAME::SetDrawBgColor(), SetPageSettings(), PAGE_INFO::SetType(), GRID_SETTINGS::sizes, WHITE, WINDOW_SETTINGS::zoom_factors, and ZOOM_LIST_PL_EDITOR.
|
inherited |
Load window settings from the given settings object.
Normally called by LoadSettings() unless the window in question is a child window that* stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.
Definition at line 709 of file eda_base_frame.cpp.
References TOOLS_HOLDER::CommonSettingsChanged(), EDA_BASE_FRAME::LoadWindowState(), EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_perspective, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), and WINDOW_SETTINGS::state.
Referenced by EDA_BASE_FRAME::LoadSettings().
|
inherited |
Definition at line 549 of file eda_base_frame.cpp.
References PROJECT_LOCAL_SETTINGS::GetFileState(), PROJECT::GetLocalSettings(), Pgm(), KIWAY_HOLDER::Prj(), and PROJECT_FILE_STATE::window.
Referenced by KICAD_MANAGER_FRAME::LoadProject(), PCB_EDIT_FRAME::LoadProjectSettings(), EDA_BASE_FRAME::LoadWindowSettings(), and SCH_EDIT_FRAME::OpenProjectFiles().
|
virtualinherited |
Load frame state info from a configuration file.
Definition at line 563 of file eda_base_frame.cpp.
References PCAD2KICAD::Center, defaultSize(), WINDOW_STATE::display, EDA_BASE_FRAME::m_displayIndex, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_ident, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, minSize(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.
|
inherited |
Mark a schematic file as being in use.
Use ReleaseFile() to undo this.
aFileName | full path to the file. |
Definition at line 208 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::m_file_checker.
Referenced by SCH_EDIT_FRAME::importFile(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProject().
|
inlineinherited |
Definition at line 584 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_isNonUserClose.
Referenced by KIWAY::PlayerClose().
|
protectedinherited |
Definition at line 1136 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::handleActivateEvent().
|
protectedinherited |
Handle the auto save timer event.
Definition at line 320 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::m_autoSaveInterval, and EDA_BASE_FRAME::m_autoSaveTimer.
Referenced by EDA_BASE_FRAME::commonInit().
|
virtualinherited |
Capture the key event before it is sent to the GUI.
The basic frame does not capture this event. Editor frames should override this event function to capture and filter these keys when they are used as hotkeys, and skip it if the key is not used as hotkey (otherwise the key events will be not sent to menus).
Reimplemented in FOOTPRINT_VIEWER_FRAME.
Definition at line 333 of file eda_base_frame.cpp.
References dump(), and kicadTraceKeyEvent.
void PL_EDITOR_FRAME::OnClearFileHistory | ( | wxCommandEvent & | aEvent | ) |
Definition at line 88 of file pagelayout_editor/files.cpp.
References EDA_BASE_FRAME::ClearFileHistory().
void PL_EDITOR_FRAME::OnExit | ( | wxCommandEvent & | aEvent | ) |
Event handler for the wxID_EXIT and wxID_CLOSE events.
Definition at line 358 of file pl_editor_frame.cpp.
References KIFACE_BASE::IsSingle(), Kiface(), KIWAY_HOLDER::Kiway(), and KIWAY::OnKiCadExit().
void PL_EDITOR_FRAME::OnFileHistory | ( | wxCommandEvent & | event | ) |
Definition at line 53 of file pagelayout_editor/files.cpp.
References _, EDA_BASE_FRAME::GetFileFromHistory(), HandleUnsavedChanges(), IsContentModified(), LoadDrawingSheetFile(), OnNewDrawingSheet(), and saveCurrentPageLayout().
|
inherited |
Definition at line 396 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::Refresh(), and EDA_DRAW_FRAME::UpdateStatusBar().
|
inherited |
Definition at line 994 of file eda_base_frame.cpp.
References ShowAboutDialog().
|
inherited |
Definition at line 1213 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, and traceDisplayLocation.
|
inherited |
The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves.
Definition at line 343 of file eda_base_frame.cpp.
References TOOL_DISPATCHER::DispatchWxEvent(), and TOOLS_HOLDER::m_toolDispatcher.
|
inline |
Must be called after a change in order to set the "modify" flag.
Definition at line 237 of file pl_editor_frame.h.
References EDA_DRAW_FRAME::GetScreen(), and BASE_SCREEN::SetContentModified().
Referenced by PL_EDIT_TOOL::DoDelete(), PL_DRAWING_TOOLS::DrawShape(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PROPERTIES_FRAME::OnAcceptPrms(), PL_EDITOR_CONTROL::PageSetup(), and PL_DRAWING_TOOLS::PlaceItem().
|
overridevirtualinherited |
Reimplemented from EDA_BASE_FRAME.
Definition at line 475 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_FRAME::m_canvas, EDA_DRAW_FRAME::m_galDisplayOptions, KIGFX::GAL_DISPLAY_OPTIONS::m_scaleFactor, KIGFX::VIEW::MarkDirty(), KIGFX::GAL::ResizeScreen(), and KIGFX::GAL_DISPLAY_OPTIONS::UpdateScaleFactor().
void PL_EDITOR_FRAME::OnNewDrawingSheet | ( | ) |
Must be called to initialize parameters when a new drawing sheet is loaded.
Definition at line 895 of file pl_editor_frame.cpp.
References _, EDA_BASE_FRAME::ClearUndoRedoList(), PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), GetCanvas(), GetCurrentFileName(), EDA_DRAW_FRAME::GetScreen(), m_propertiesPagelayout, TOOLS_HOLDER::m_toolManager, TOOL_MANAGER::RunAction(), BASE_SCREEN::SetContentModified(), KIPLATFORM::APP::SetShutdownBlockReason(), UpdateTitleAndInfo(), and ACTIONS::zoomFitScreen.
Referenced by Files_io(), OnFileHistory(), and OpenProjectFiles().
|
inlinevirtualinherited |
Called when modifying the page settings.
In derived classes it can be used to modify parameters like draw area size, and any other local parameter related to the page settings.
Reimplemented in SCH_EDIT_FRAME.
Definition at line 329 of file eda_draw_frame.h.
Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().
|
inherited |
Displays the preferences and settings of all opened editors paged dialog.
Definition at line 1001 of file eda_base_frame.cpp.
References _, KIWAY::CommonSettingsChanged(), PAGED_DIALOG::GetTreebook(), EDA_BASE_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME_NAME, KIWAY_HOLDER::Kiway(), KIWAY_PLAYER_COUNT, KIWAY::Player(), and QUALIFIED_VIEWER3D_FRAMENAME.
Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch(), and COMMON_CONTROL::OpenPreferences().
void PL_EDITOR_FRAME::OnSelectCoordOriginCorner | ( | wxCommandEvent & | event | ) |
Called when the user select one of the 4 page corner as corner reference (or the left top paper corner).
Definition at line 421 of file pl_editor_frame.cpp.
References PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), GetCanvas(), m_originSelectBox, m_originSelectChoice, EDA_DRAW_PANEL_GAL::Refresh(), and UpdateStatusBar().
|
inherited |
Command event handler for selecting grid sizes.
All commands that set the grid size should eventually end up here. This is where the application setting is saved. If you override this method, make sure you call down to the base class.
event | Command event from the grid size combobox on the toolbar. |
Definition at line 357 of file eda_draw_frame.cpp.
References dummy(), ACTIONS::gridPreset, ACTIONS::gridProperties, EDA_DRAW_FRAME::m_canvas, EDA_DRAW_FRAME::m_gridSelectBox, TOOLS_HOLDER::m_toolManager, EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), EDA_DRAW_PANEL_GAL::SetFocus(), and EDA_DRAW_FRAME::UpdateStatusBar().
void PL_EDITOR_FRAME::OnSelectPage | ( | wxCommandEvent & | event | ) |
Definition at line 412 of file pl_editor_frame.cpp.
References GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), LAYER_DRAWINGSHEET_PAGE1, LAYER_DRAWINGSHEET_PAGEn, m_pageSelectBox, EDA_DRAW_PANEL_GAL::Refresh(), and KIGFX::VIEW::SetLayerVisible().
void PL_EDITOR_FRAME::OnSelectTitleBlockDisplayMode | ( | wxCommandEvent & | event | ) |
Toggle the display mode between the normal mode and the editor mode: In normal mode, title block texts are shown like they will be shown in other kicad applications: the format symbols in texts are replaced by the actual text.
In editor mode, the format symbols in texts are not replaced by the actual text, and therefore format symbols are displayed.
|
virtualinherited |
Set the zoom factor when selected by the zoom list box in the main tool bar.
Definition at line 457 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::m_canvas, TOOLS_HOLDER::m_toolManager, EDA_DRAW_FRAME::m_zoomSelectBox, EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), EDA_DRAW_PANEL_GAL::SetFocus(), EDA_DRAW_FRAME::UpdateStatusBar(), and ACTIONS::zoomPreset.
|
overridevirtualinherited |
Recalculate the size of toolbars and display panel when the frame size changes.
Reimplemented from EDA_BASE_FRAME.
Reimplemented in FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, and SYMBOL_VIEWER_FRAME.
Definition at line 552 of file eda_draw_frame.cpp.
References EDA_BASE_FRAME::m_frameSize, and EDA_BASE_FRAME::OnSize().
Referenced by PCB_EDIT_FRAME::onSize(), and SCH_EDIT_FRAME::onSize().
|
inherited |
Definition at line 63 of file eda_dde.cpp.
References client_ipc_buffer, KIWAY_PLAYER::ExecuteRemoteCommand(), and IPC_BUF_SIZE.
|
inherited |
Definition at line 93 of file eda_dde.cpp.
References ID_EDA_SOCKET_EVENT, and KIWAY_PLAYER::m_sockets.
|
protectedinherited |
Definition at line 1277 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::HandleSystemColorChange().
|
inherited |
Update the checked item in the grid combobox.
Definition at line 336 of file eda_draw_frame.cpp.
References EDA_BASE_FRAME::config(), WINDOW_SETTINGS::grid, GRID_SETTINGS::last_size_idx, EDA_DRAW_FRAME::m_gridSelectBox, and APP_SETTINGS_BASE::m_Window.
Referenced by COMMON_TOOLS::OnGridChanged(), and EDA_DRAW_FRAME::OnSelectGrid().
|
overridevirtual |
Open a project or set of files given by aFileList.
This is generalized in the direction of worst case. In a typical case aFileList will only hold a single file, like "myboard.kicad_pcb" because any KIWAY_PLAYER is only in one