KiCad PCB EDA Suite
EDA_PANEINFO Class Reference

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

#include <wxstruct.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 465 of file wxstruct.h.

Member Function Documentation

EDA_PANEINFO& EDA_PANEINFO::HorizontalToolbarPane ( )
inline

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

Definition at line 474 of file wxstruct.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_TOOL_RANGE(), EVT_UPDATE_UI(), EVT_UPDATE_UI_RANGE(), GERBVIEW_FRAME::GERBVIEW_FRAME(), KICAD_MANAGER_FRAME::KICAD_MANAGER_FRAME(), LIB_EDIT_FRAME::LIB_EDIT_FRAME(), and PL_EDITOR_FRAME::PL_EDITOR_FRAME().

475  {
476  ToolbarPane();
477  CloseButton( false );
478  LeftDockable( false );
479  RightDockable( false );
480  //==================== Remove calls below here for movable toolbars //
481  Gripper( false );
482  DockFixed( true );
483  Movable( false );
484  Resizable( true );
485  return *this;
486  }
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 539 of file wxstruct.h.

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

540  {
541  Gripper( false );
542  CloseButton( false );
543  CaptionVisible( false );
544  return *this;
545  }
EDA_PANEINFO& EDA_PANEINFO::LayersToolbarPane ( )
inline

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

Definition at line 526 of file wxstruct.h.

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

527  {
528  CloseButton( false );
529  return *this;
530  }
EDA_PANEINFO& EDA_PANEINFO::MessageToolbarPane ( )
inline

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

Definition at line 511 of file wxstruct.h.

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

512  {
513  Gripper( false );
514  DockFixed( true );
515  Movable( false );
516  Floatable( false );
517  CloseButton( false );
518  CaptionVisible( false );
519  return *this;
520  }
EDA_PANEINFO& EDA_PANEINFO::VerticalToolbarPane ( )
inline

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

Definition at line 492 of file wxstruct.h.

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

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

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