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

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 686 of file eda_base_frame.h.

687  {
688  Gripper( false );
689  CloseButton( false );
690  PaneBorder( false );
691  }

Member Function Documentation

◆ Canvas()

EDA_PANE& EDA_PANE::Canvas ( )
inline

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

Definition at line 734 of file eda_base_frame.h.

735  {
736  CaptionVisible( false );
737  Layer( 0 );
738  PaneBorder( true );
739  Resizable( true ); // expand to fit available space
740  return *this;
741  }

◆ HToolbar()

EDA_PANE& EDA_PANE::HToolbar ( )
inline

Turn *this to a horizontal toolbar for KiCad.

Definition at line 696 of file eda_base_frame.h.

697  {
698  SetFlag( optionToolbar, true );
699  CaptionVisible( false );
700  TopDockable().BottomDockable();
701  DockFixed( true );
702  Movable( false );
703  Resizable( true ); // expand to fit available space
704  return *this;
705  }

◆ InfoBar()

EDA_PANE& EDA_PANE::InfoBar ( )
inline

Turn *this into a infobar for KiCad.

Definition at line 759 of file eda_base_frame.h.

760  {
761  CaptionVisible( false );
762  Movable( false );
763  Resizable( true );
764  PaneBorder( false );
765  DockFixed( true );
766  return *this;
767  }

◆ Messages()

EDA_PANE& EDA_PANE::Messages ( )
inline

Turn *this into a messages pane for KiCad.

Definition at line 746 of file eda_base_frame.h.

747  {
748  CaptionVisible( false );
749  BottomDockable( true );
750  DockFixed( true );
751  Movable( false );
752  Resizable( true ); // expand to fit available space
753  return *this;
754  }

◆ Palette()

EDA_PANE& EDA_PANE::Palette ( )
inline

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

Definition at line 724 of file eda_base_frame.h.

725  {
726  CaptionVisible( true );
727  PaneBorder( true );
728  return *this;
729  }

◆ VToolbar()

EDA_PANE& EDA_PANE::VToolbar ( )
inline

Turn *this into a vertical toolbar for KiCad.

Definition at line 710 of file eda_base_frame.h.

711  {
712  SetFlag( optionToolbar, true );
713  CaptionVisible( false );
714  LeftDockable().RightDockable();
715  DockFixed( true );
716  Movable( false );
717  Resizable( true ); // expand to fit available space
718  return *this;
719  }

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