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

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 722 of file eda_base_frame.h.

723  {
724  Gripper( false );
725  CloseButton( false );
726  PaneBorder( false );
727  }

Member Function Documentation

◆ Canvas()

EDA_PANE& EDA_PANE::Canvas ( )
inline

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

Definition at line 770 of file eda_base_frame.h.

771  {
772  CaptionVisible( false );
773  Layer( 0 );
774  PaneBorder( true );
775  Resizable( true ); // expand to fit available space
776  return *this;
777  }

◆ HToolbar()

EDA_PANE& EDA_PANE::HToolbar ( )
inline

Turn *this to a horizontal toolbar for KiCad.

Definition at line 732 of file eda_base_frame.h.

733  {
734  SetFlag( optionToolbar, true );
735  CaptionVisible( false );
736  TopDockable().BottomDockable();
737  DockFixed( true );
738  Movable( false );
739  Resizable( true ); // expand to fit available space
740  return *this;
741  }

◆ InfoBar()

EDA_PANE& EDA_PANE::InfoBar ( )
inline

Turn *this into a infobar for KiCad.

Definition at line 795 of file eda_base_frame.h.

796  {
797  CaptionVisible( false );
798  Movable( false );
799  Resizable( true );
800  PaneBorder( false );
801  DockFixed( true );
802  return *this;
803  }

◆ Messages()

EDA_PANE& EDA_PANE::Messages ( )
inline

Turn *this into a messages pane for KiCad.

Definition at line 782 of file eda_base_frame.h.

783  {
784  CaptionVisible( false );
785  BottomDockable( true );
786  DockFixed( true );
787  Movable( false );
788  Resizable( true ); // expand to fit available space
789  return *this;
790  }

◆ Palette()

EDA_PANE& EDA_PANE::Palette ( )
inline

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

Definition at line 760 of file eda_base_frame.h.

761  {
762  CaptionVisible( true );
763  PaneBorder( true );
764  return *this;
765  }

◆ VToolbar()

EDA_PANE& EDA_PANE::VToolbar ( )
inline

Turn *this into a vertical toolbar for KiCad.

Definition at line 746 of file eda_base_frame.h.

747  {
748  SetFlag( optionToolbar, true );
749  CaptionVisible( false );
750  LeftDockable().RightDockable();
751  DockFixed( true );
752  Movable( false );
753  Resizable( true ); // expand to fit available space
754  return *this;
755  }

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