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

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 760 of file eda_base_frame.h.

761  {
762  Gripper( false );
763  CloseButton( false );
764  PaneBorder( false );
765  }

Member Function Documentation

◆ Canvas()

EDA_PANE& EDA_PANE::Canvas ( )
inline

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

Definition at line 808 of file eda_base_frame.h.

809  {
810  CaptionVisible( false );
811  Layer( 0 );
812  PaneBorder( true );
813  Resizable( true ); // expand to fit available space
814  return *this;
815  }

◆ HToolbar()

EDA_PANE& EDA_PANE::HToolbar ( )
inline

Turn *this to a horizontal toolbar for KiCad.

Definition at line 770 of file eda_base_frame.h.

771  {
772  SetFlag( optionToolbar, true );
773  CaptionVisible( false );
774  TopDockable().BottomDockable();
775  DockFixed( true );
776  Movable( false );
777  Resizable( true ); // expand to fit available space
778  return *this;
779  }

◆ InfoBar()

EDA_PANE& EDA_PANE::InfoBar ( )
inline

Turn *this into a infobar for KiCad.

Definition at line 833 of file eda_base_frame.h.

834  {
835  CaptionVisible( false );
836  Movable( false );
837  Resizable( true );
838  PaneBorder( false );
839  DockFixed( true );
840  return *this;
841  }

◆ Messages()

EDA_PANE& EDA_PANE::Messages ( )
inline

Turn *this into a messages pane for KiCad.

Definition at line 820 of file eda_base_frame.h.

821  {
822  CaptionVisible( false );
823  BottomDockable( true );
824  DockFixed( true );
825  Movable( false );
826  Resizable( true ); // expand to fit available space
827  return *this;
828  }

◆ Palette()

EDA_PANE& EDA_PANE::Palette ( )
inline

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

Definition at line 798 of file eda_base_frame.h.

799  {
800  CaptionVisible( true );
801  PaneBorder( true );
802  return *this;
803  }

◆ VToolbar()

EDA_PANE& EDA_PANE::VToolbar ( )
inline

Turn *this into a vertical toolbar for KiCad.

Definition at line 784 of file eda_base_frame.h.

785  {
786  SetFlag( optionToolbar, true );
787  CaptionVisible( false );
788  LeftDockable().RightDockable();
789  DockFixed( true );
790  Movable( false );
791  Resizable( true ); // expand to fit available space
792  return *this;
793  }

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