KiCad PCB EDA Suite
EDA_PANE Class Reference

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

#include <eda_base_frame.h>

Inheritance diagram for EDA_PANE:

Public Member Functions

 EDA_PANE ()
 
EDA_PANEHToolbar ()
 Turn *this to a horizontal toolbar for KiCad. More...
 
EDA_PANEVToolbar ()
 Turn *this into a vertical toolbar for KiCad. More...
 
EDA_PANEPalette ()
 Turn *this into a captioned palette suitable for a symbol tree, layers manager, etc. More...
 
EDA_PANECanvas ()
 Turn *this into an undecorated pane suitable for a drawing canvas. More...
 
EDA_PANEMessages ()
 Turn *this into a messages pane for KiCad. More...
 
EDA_PANEInfoBar ()
 Turn *this into a infobar 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 its 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 765 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 768 of file eda_base_frame.h.

769  {
770  Gripper( false );
771  CloseButton( false );
772  PaneBorder( false );
773  }

Member Function Documentation

◆ Canvas()

EDA_PANE& EDA_PANE::Canvas ( )
inline

Turn *this into an undecorated pane suitable for a drawing canvas.

Definition at line 816 of file eda_base_frame.h.

817  {
818  CaptionVisible( false );
819  Layer( 0 );
820  PaneBorder( true );
821  Resizable( true ); // expand to fit available space
822  return *this;
823  }

◆ HToolbar()

EDA_PANE& EDA_PANE::HToolbar ( )
inline

Turn *this to a horizontal toolbar for KiCad.

Definition at line 778 of file eda_base_frame.h.

779  {
780  SetFlag( optionToolbar, true );
781  CaptionVisible( false );
782  TopDockable().BottomDockable();
783  DockFixed( true );
784  Movable( false );
785  Resizable( true ); // expand to fit available space
786  return *this;
787  }

◆ InfoBar()

EDA_PANE& EDA_PANE::InfoBar ( )
inline

Turn *this into a infobar for KiCad.

Definition at line 841 of file eda_base_frame.h.

842  {
843  CaptionVisible( false );
844  Movable( false );
845  Resizable( true );
846  PaneBorder( false );
847  DockFixed( true );
848  return *this;
849  }

◆ Messages()

EDA_PANE& EDA_PANE::Messages ( )
inline

Turn *this into a messages pane for KiCad.

Definition at line 828 of file eda_base_frame.h.

829  {
830  CaptionVisible( false );
831  BottomDockable( true );
832  DockFixed( true );
833  Movable( false );
834  Resizable( true ); // expand to fit available space
835  return *this;
836  }

◆ Palette()

EDA_PANE& EDA_PANE::Palette ( )
inline

Turn *this into a captioned palette suitable for a symbol tree, layers manager, etc.

Definition at line 806 of file eda_base_frame.h.

807  {
808  CaptionVisible( true );
809  PaneBorder( true );
810  return *this;
811  }

◆ VToolbar()

EDA_PANE& EDA_PANE::VToolbar ( )
inline

Turn *this into a vertical toolbar for KiCad.

Definition at line 792 of file eda_base_frame.h.

793  {
794  SetFlag( optionToolbar, true );
795  CaptionVisible( false );
796  LeftDockable().RightDockable();
797  DockFixed( true );
798  Movable( false );
799  Resizable( true ); // expand to fit available space
800  return *this;
801  }

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