summaryrefslogtreecommitdiff
path: root/pcbnew/class_pcb_layer_widget.h
diff options
context:
space:
mode:
authorsaurabhb172020-02-26 16:00:53 +0530
committerGitHub2020-02-26 16:00:53 +0530
commit886d9cb772e81d2e5262284bc3082664f084337f (patch)
tree6acee185a4dc19113fcbf0f9a3d6941085dedaf7 /pcbnew/class_pcb_layer_widget.h
parent0db48f6533517ecebfd9f0693f89deca28408b76 (diff)
parentaa35045840b78d3f48212db45da59a2e5c69b223 (diff)
downloadKiCad-eSim-886d9cb772e81d2e5262284bc3082664f084337f.tar.gz
KiCad-eSim-886d9cb772e81d2e5262284bc3082664f084337f.tar.bz2
KiCad-eSim-886d9cb772e81d2e5262284bc3082664f084337f.zip
Merge pull request #1 from saurabhb17/develop
Added main functions
Diffstat (limited to 'pcbnew/class_pcb_layer_widget.h')
-rw-r--r--pcbnew/class_pcb_layer_widget.h158
1 files changed, 158 insertions, 0 deletions
diff --git a/pcbnew/class_pcb_layer_widget.h b/pcbnew/class_pcb_layer_widget.h
new file mode 100644
index 0000000..7908d80
--- /dev/null
+++ b/pcbnew/class_pcb_layer_widget.h
@@ -0,0 +1,158 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2004-2015 Jean-Pierre Charras, jean-pierre.charras@gpisa-lab.inpg.fr
+ * Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
+ * Copyright (C) 2010-2015 KiCad Developers, see change_log.txt for contributors.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+
+/************************************************************/
+/* class_pcb_layer_widget.h : header for the layers manager */
+/************************************************************/
+
+#ifndef CLASS_PCB_LAYER_WIDGET_H_
+#define CLASS_PCB_LAYER_WIDGET_H_
+
+#include <layer_widget.h>
+
+/**
+ * Class PCB_LAYER_WIDGET
+ * is here to implement the abstract functions of LAYER_WIDGET so they
+ * may be tied into the PCB_EDIT_FRAME's data and so we can add a popup
+ * menu which is specific to PCBNEW's needs.
+ */
+class PCB_LAYER_WIDGET : public LAYER_WIDGET
+{
+public:
+
+ /**
+ * Constructor
+ * @param aParent is the parent window
+ * @param aFocusOwner is the window that should be sent the focus after
+ * @param aPointSize is the font point size to use within the widget. This
+ * effectively sets the overall size of the widget via the row height and bitmap
+ * button sizes.
+ * @param aFpEditorMode false for the board editor (default), true for fp editor
+ * when true, some options or layers which cannot be used in editor mode are not
+ * displayed
+ */
+ PCB_LAYER_WIDGET( PCB_BASE_FRAME* aParent, wxWindow* aFocusOwner,
+ int aPointSize = 10, bool aFpEditorMode = false );
+
+ void ReFill();
+
+ /**
+ * Function ReFillRender
+ * rebuilds Render for instance after the config is read
+ */
+ void ReFillRender();
+
+ /**
+ * Function SyncRenderStates
+ * updates the checkboxes (checked or not) to be consistent with the current state
+ * of the visibility of the visible rendering elements.
+ */
+ void SyncRenderStates();
+
+ /**
+ * Function SyncLayerVisibilities
+ * updates each "Layer" checkbox in this layer widget according
+ * to each layer's current visibility determined by IsLayerVisible(), and is
+ * helpful immediately after loading a BOARD which may have state information in it.
+ */
+ void SyncLayerVisibilities();
+
+ /**
+ * Function SetLayersManagerTabsText
+ * Update the layer manager tabs labels
+ * Useful when changing Language or to set labels to a non default value
+ */
+ void SetLayersManagerTabsText();
+
+ //-----<implement LAYER_WIDGET abstract callback functions>-----------
+ void OnLayerColorChange( int aLayer, EDA_COLOR_T aColor );
+ bool OnLayerSelect( int aLayer );
+ void OnLayerVisible( int aLayer, bool isVisible, bool isFinal );
+ void OnRenderColorChange( int aId, EDA_COLOR_T aColor );
+ void OnRenderEnable( int aId, bool isEnabled );
+ //-----</implement LAYER_WIDGET abstract callback functions>----------
+
+ /**
+ * Function OnLayerSelected
+ * ensure the active layer is visible, and other layers not visible
+ * when m_alwaysShowActiveLayer is true
+ * Otherwise do nothing.
+ * @return true m_alwaysShowActiveLayer is true and the canvas is refreshed,
+ * and false if do nothing
+ */
+ bool OnLayerSelected(); // postprocess after an active layer selection
+ // ensure active layer visible if
+ // m_alwaysShowActiveCopperLayer is true;
+
+
+protected:
+
+ static const LAYER_WIDGET::ROW s_render_rows[];
+ bool m_alwaysShowActiveCopperLayer; // If true: Only shows the current active layer
+ // even if it is changed
+ bool m_fp_editor_mode;
+
+ PCB_BASE_FRAME* myframe;
+
+ // popup menu ids.
+#define ID_SHOW_ALL_COPPERS wxID_HIGHEST
+#define ID_SHOW_NO_COPPERS (wxID_HIGHEST+1)
+#define ID_SHOW_NO_COPPERS_BUT_ACTIVE (wxID_HIGHEST+2)
+#define ID_ALWAYS_SHOW_NO_COPPERS_BUT_ACTIVE (wxID_HIGHEST+3)
+
+ /**
+ * Function isAllowedInFpMode
+ * @return true if item aId has meaning in footprint editor mode.
+ * and therefore is shown in render panel
+ */
+ bool isAllowedInFpMode( int aId );
+
+ /**
+ * Function isLayerAllowedInFpMode
+ *
+ * User layers, which are not paired, are not shown in layers manager. However a not
+ * listed layer can be reachable in the graphic item properties dialog.
+ *
+ * @param aLayer is the layer id to test
+ * @return true if LAYER_ID aLayer has meaning in footprint editor mode.
+ * and therefore is shown in render panel
+ */
+ bool isLayerAllowedInFpMode( LAYER_ID aLayer );
+
+ /**
+ * Function OnRightDownLayers
+ * puts up a popup menu for the layer panel.
+ */
+ void onRightDownLayers( wxMouseEvent& event );
+
+ void onPopupSelection( wxCommandEvent& event );
+
+ /// this is for the popup menu, the right click handler has to be installed
+ /// on every child control within the layer panel.
+ void installRightLayerClickHandler();
+};
+
+#endif // CLASS_PCB_LAYER_WIDGET_H_