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

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 551 of file eda_base_frame.h.

552  {
553  Gripper( false );
554  CloseButton( false );
555  PaneBorder( false );
556  }

Member Function Documentation

◆ Canvas()

EDA_PANE& EDA_PANE::Canvas ( )
inline

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

Definition at line 599 of file eda_base_frame.h.

600  {
601  CaptionVisible( false );
602  Layer( 0 );
603  PaneBorder( true );
604  Resizable( true ); // expand to fit available space
605  return *this;
606  }

◆ HToolbar()

EDA_PANE& EDA_PANE::HToolbar ( )
inline

Turn *this to a horizontal toolbar for KiCad.

Definition at line 561 of file eda_base_frame.h.

562  {
563  SetFlag( optionToolbar, true );
564  CaptionVisible( false );
565  TopDockable().BottomDockable();
566  DockFixed( true );
567  Movable( false );
568  Resizable( true ); // expand to fit available space
569  return *this;
570  }

◆ InfoBar()

EDA_PANE& EDA_PANE::InfoBar ( )
inline

Turn *this into a infobar for KiCad.

Definition at line 624 of file eda_base_frame.h.

625  {
626  CaptionVisible( false );
627  Movable( false );
628  Resizable( true );
629  PaneBorder( false );
630  DockFixed( true );
631  return *this;
632  }

◆ Messages()

EDA_PANE& EDA_PANE::Messages ( )
inline

Turn *this into a messages pane for KiCad.

Definition at line 611 of file eda_base_frame.h.

612  {
613  CaptionVisible( false );
614  BottomDockable( true );
615  DockFixed( true );
616  Movable( false );
617  Resizable( true ); // expand to fit available space
618  return *this;
619  }

◆ Palette()

EDA_PANE& EDA_PANE::Palette ( )
inline

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

Definition at line 589 of file eda_base_frame.h.

590  {
591  CaptionVisible( true );
592  PaneBorder( true );
593  return *this;
594  }

◆ VToolbar()

EDA_PANE& EDA_PANE::VToolbar ( )
inline

Turn *this into a vertical toolbar for KiCad.

Definition at line 575 of file eda_base_frame.h.

576  {
577  SetFlag( optionToolbar, true );
578  CaptionVisible( false );
579  LeftDockable().RightDockable();
580  DockFixed( true );
581  Movable( false );
582  Resizable( true ); // expand to fit available space
583  return *this;
584  }

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