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 766 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 769 of file eda_base_frame.h.

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

Member Function Documentation

◆ Canvas()

EDA_PANE& EDA_PANE::Canvas ( )
inline

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

Definition at line 817 of file eda_base_frame.h.

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

◆ HToolbar()

EDA_PANE& EDA_PANE::HToolbar ( )
inline

Turn *this to a horizontal toolbar for KiCad.

Definition at line 779 of file eda_base_frame.h.

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

◆ InfoBar()

EDA_PANE& EDA_PANE::InfoBar ( )
inline

Turn *this into a infobar for KiCad.

Definition at line 842 of file eda_base_frame.h.

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

◆ Messages()

EDA_PANE& EDA_PANE::Messages ( )
inline

Turn *this into a messages pane for KiCad.

Definition at line 829 of file eda_base_frame.h.

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

◆ Palette()

EDA_PANE& EDA_PANE::Palette ( )
inline

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

Definition at line 807 of file eda_base_frame.h.

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

◆ VToolbar()

EDA_PANE& EDA_PANE::VToolbar ( )
inline

Turn *this into a vertical toolbar for KiCad.

Definition at line 793 of file eda_base_frame.h.

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

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