KiCad PCB EDA Suite
EDA_PANEINFO Class Reference

Specialization of the wxAuiPaneInfo class for KiCad panels. More...

#include <eda_base_frame.h>

Inheritance diagram for EDA_PANEINFO:

Public Member Functions

EDA_PANEINFOHorizontalToolbarPane ()
 Function HorizontalToolbarPane Change *this to a horizontal toolbar for KiCad. More...
 
EDA_PANEINFOVerticalToolbarPane ()
 Function VerticalToolbarPane Change *this to a vertical toolbar for KiCad. More...
 
EDA_PANEINFOMessageToolbarPane ()
 Function MessageToolbarPane Change *this to a message pane for KiCad. More...
 
EDA_PANEINFOLayersToolbarPane ()
 Function LayersToolbarPane Change *this to a layers toolbar for KiCad. More...
 
EDA_PANEINFOInfoToolbarPane ()
 Function InfoToolbarPane Change *this to a information panel for for KiCad. More...
 

Detailed Description

Specialization of the wxAuiPaneInfo class for KiCad panels.

Documentation for wxAui is poor at this time. The following notes spring from errors made in previous KiCad implementations:

wxAuiPaneInfo.ToolbarPane() and .Defaults() are used to clear and then prepare the objects so only use them once at the beginning of configuration..

Panels are organized in layers, from 0 (close to the center) and increasing outward. Note that for ToolbarPanes, layer 0 considered a special default value, and ToolbarPanes on layer 0 are pushed to layer 10 automatically. Use Layer 1 for the inner layer as a work- around.

Each panel has rows, starting at 0. Each row has positions starting at 0. Each item in a panel can have it's row and position set.

Eventually panels will be movable. Each initialization function sets up the panel for this, then after a //==// break has additional calls to anchor toolbars in a way that matches present functionality.

Definition at line 491 of file eda_base_frame.h.

Member Function Documentation

EDA_PANEINFO& EDA_PANEINFO::HorizontalToolbarPane ( )
inline

Function HorizontalToolbarPane Change *this to a horizontal toolbar for KiCad.

Definition at line 500 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EDA_3D_VIEWER::EDA_3D_VIEWER(), EVT_GRID_CMD_CELL_CHANGED(), EVT_UPDATE_UI(), EVT_UPDATE_UI_RANGE(), GERBVIEW_FRAME::GERBVIEW_FRAME(), KICAD_MANAGER_FRAME::KICAD_MANAGER_FRAME(), LIB_EDIT_FRAME::LIB_EDIT_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), PCB_EDIT_FRAME::PCB_EDIT_FRAME(), and PL_EDITOR_FRAME::PL_EDITOR_FRAME().

501  {
502  ToolbarPane();
503  CloseButton( false );
504  LeftDockable( false );
505  RightDockable( false );
506  //==================== Remove calls below here for movable toolbars //
507  Gripper( false );
508  DockFixed( true );
509  Movable( false );
510  Resizable( true );
511  return *this;
512  }
EDA_PANEINFO& EDA_PANEINFO::InfoToolbarPane ( )
inline

Function InfoToolbarPane Change *this to a information panel for for KiCad.

Info panes are used for vertical display of information next to the center pane. Used in CvPcb and the library viewer primarily.

Definition at line 565 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), EVT_GRID_CMD_CELL_CHANGED(), EVT_TOOL(), KICAD_MANAGER_FRAME::KICAD_MANAGER_FRAME(), and LIB_VIEW_FRAME::LIB_VIEW_FRAME().

566  {
567  Gripper( false );
568  CloseButton( false );
569  CaptionVisible( false );
570  return *this;
571  }
EDA_PANEINFO& EDA_PANEINFO::LayersToolbarPane ( )
inline

Function LayersToolbarPane Change *this to a layers toolbar for KiCad.

Definition at line 552 of file eda_base_frame.h.

Referenced by EVT_UPDATE_UI(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_EDIT_FRAME::PCB_EDIT_FRAME(), and PL_EDITOR_FRAME::PL_EDITOR_FRAME().

553  {
554  CloseButton( false );
555  return *this;
556  }
EDA_PANEINFO& EDA_PANEINFO::MessageToolbarPane ( )
inline

Function MessageToolbarPane Change *this to a message pane for KiCad.

Definition at line 537 of file eda_base_frame.h.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EVT_GRID_CMD_CELL_CHANGED(), EVT_TOOL(), EVT_UPDATE_UI(), EVT_UPDATE_UI_RANGE(), GERBVIEW_FRAME::GERBVIEW_FRAME(), LIB_EDIT_FRAME::LIB_EDIT_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), PCB_EDIT_FRAME::PCB_EDIT_FRAME(), and PL_EDITOR_FRAME::PL_EDITOR_FRAME().

538  {
539  Gripper( false );
540  DockFixed( true );
541  Movable( false );
542  Floatable( false );
543  CloseButton( false );
544  CaptionVisible( false );
545  return *this;
546  }
EDA_PANEINFO& EDA_PANEINFO::VerticalToolbarPane ( )
inline

Function VerticalToolbarPane Change *this to a vertical toolbar for KiCad.

Definition at line 518 of file eda_base_frame.h.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EVT_UPDATE_UI(), EVT_UPDATE_UI_RANGE(), GERBVIEW_FRAME::GERBVIEW_FRAME(), LIB_EDIT_FRAME::LIB_EDIT_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), PCB_EDIT_FRAME::PCB_EDIT_FRAME(), and PL_EDITOR_FRAME::PL_EDITOR_FRAME().

519  {
520  ToolbarPane();
521  CloseButton( false );
522  TopDockable( false );
523  BottomDockable( false );
524  //==================== Remove calls below here for movable toolbars //
525  Gripper( false );
526  DockFixed( true );
527  Movable( false );
528  Resizable( true );
529  return *this;
530  }

The documentation for this class was generated from the following file: