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...
 

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

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 528 of file eda_base_frame.h.

529  {
530  Gripper( false );
531  CloseButton( false );
532  PaneBorder( false );
533  }

Member Function Documentation

◆ Canvas()

EDA_PANE& EDA_PANE::Canvas ( )
inline

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

Definition at line 576 of file eda_base_frame.h.

577  {
578  CaptionVisible( false );
579  Layer( 0 );
580  PaneBorder( true );
581  Resizable( true ); // expand to fit available space
582  return *this;
583  }

◆ HToolbar()

EDA_PANE& EDA_PANE::HToolbar ( )
inline

Turn *this to a horizontal toolbar for KiCad.

Definition at line 538 of file eda_base_frame.h.

539  {
540  SetFlag( optionToolbar, true );
541  CaptionVisible( false );
542  TopDockable().BottomDockable();
543  DockFixed( true );
544  Movable( false );
545  Resizable( true ); // expand to fit available space
546  return *this;
547  }

◆ Messages()

EDA_PANE& EDA_PANE::Messages ( )
inline

Turn *this into a messages pane for KiCad.

Definition at line 588 of file eda_base_frame.h.

589  {
590  CaptionVisible( false );
591  BottomDockable( true );
592  DockFixed( true );
593  Movable( false );
594  Resizable( true ); // expand to fit available space
595  return *this;
596  }

◆ Palette()

EDA_PANE& EDA_PANE::Palette ( )
inline

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

Definition at line 566 of file eda_base_frame.h.

567  {
568  CaptionVisible( true );
569  PaneBorder( true );
570  return *this;
571  }

◆ VToolbar()

EDA_PANE& EDA_PANE::VToolbar ( )
inline

Turn *this into a vertical toolbar for KiCad.

Definition at line 552 of file eda_base_frame.h.

553  {
554  SetFlag( optionToolbar, true );
555  CaptionVisible( false );
556  LeftDockable().RightDockable();
557  DockFixed( true );
558  Movable( false );
559  Resizable( true ); // expand to fit available space
560  return *this;
561  }

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