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 469 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 478 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(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), 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(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), and SCH_EDIT_FRAME::SCH_EDIT_FRAME().

479  {
480  ToolbarPane();
481  CloseButton( false );
482  LeftDockable( false );
483  RightDockable( false );
484  //==================== Remove calls below here for movable toolbars //
485  Gripper( false );
486  DockFixed( true );
487  Movable( false );
488  Resizable( true );
489  return *this;
490  }
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 543 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().

544  {
545  Gripper( false );
546  CloseButton( false );
547  CaptionVisible( false );
548  return *this;
549  }
EDA_PANEINFO& EDA_PANEINFO::LayersToolbarPane ( )
inline

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

Definition at line 530 of file eda_base_frame.h.

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

531  {
532  CloseButton( false );
533  return *this;
534  }
EDA_PANEINFO& EDA_PANEINFO::MessageToolbarPane ( )
inline

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

Definition at line 515 of file eda_base_frame.h.

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

516  {
517  Gripper( false );
518  DockFixed( true );
519  Movable( false );
520  Floatable( false );
521  CloseButton( false );
522  CaptionVisible( false );
523  return *this;
524  }
EDA_PANEINFO& EDA_PANEINFO::VerticalToolbarPane ( )
inline

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

Definition at line 496 of file eda_base_frame.h.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), LIB_EDIT_FRAME::LIB_EDIT_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), PCB_EDIT_FRAME::PCB_EDIT_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), and SCH_EDIT_FRAME::SCH_EDIT_FRAME().

497  {
498  ToolbarPane();
499  CloseButton( false );
500  TopDockable( false );
501  BottomDockable( false );
502  //==================== Remove calls below here for movable toolbars //
503  Gripper( false );
504  DockFixed( true );
505  Movable( false );
506  Resizable( true );
507  return *this;
508  }

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