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 485 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 494 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(), 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().

495  {
496  ToolbarPane();
497  CloseButton( false );
498  LeftDockable( false );
499  RightDockable( false );
500  //==================== Remove calls below here for movable toolbars //
501  Gripper( false );
502  DockFixed( true );
503  Movable( false );
504  Resizable( true );
505  return *this;
506  }
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 559 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().

560  {
561  Gripper( false );
562  CloseButton( false );
563  CaptionVisible( false );
564  return *this;
565  }
EDA_PANEINFO& EDA_PANEINFO::LayersToolbarPane ( )
inline

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

Definition at line 546 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().

547  {
548  CloseButton( false );
549  return *this;
550  }
EDA_PANEINFO& EDA_PANEINFO::MessageToolbarPane ( )
inline

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

Definition at line 531 of file eda_base_frame.h.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EVT_GRID_CMD_CELL_CHANGED(), EVT_TOOL(), EVT_UPDATE_UI(), 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().

532  {
533  Gripper( false );
534  DockFixed( true );
535  Movable( false );
536  Floatable( false );
537  CloseButton( false );
538  CaptionVisible( false );
539  return *this;
540  }
EDA_PANEINFO& EDA_PANEINFO::VerticalToolbarPane ( )
inline

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

Definition at line 512 of file eda_base_frame.h.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EVT_UPDATE_UI(), 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().

513  {
514  ToolbarPane();
515  CloseButton( false );
516  TopDockable( false );
517  BottomDockable( false );
518  //==================== Remove calls below here for movable toolbars //
519  Gripper( false );
520  DockFixed( true );
521  Movable( false );
522  Resizable( true );
523  return *this;
524  }

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