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

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 495 of file eda_base_frame.h.

496  {
497  Gripper( false );
498  CloseButton( false );
499  PaneBorder( false );
500  }

Member Function Documentation

◆ Canvas()

EDA_PANE& EDA_PANE::Canvas ( )
inline

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

Definition at line 543 of file eda_base_frame.h.

544  {
545  CaptionVisible( false );
546  Layer( 0 );
547  PaneBorder( true );
548  Resizable( true ); // expand to fit available space
549  return *this;
550  }

◆ HToolbar()

EDA_PANE& EDA_PANE::HToolbar ( )
inline

Turn *this to a horizontal toolbar for KiCad.

Definition at line 505 of file eda_base_frame.h.

506  {
507  SetFlag( optionToolbar, true );
508  CaptionVisible( false );
509  TopDockable().BottomDockable();
510  DockFixed( true );
511  Movable( false );
512  Resizable( true ); // expand to fit available space
513  return *this;
514  }

◆ Messages()

EDA_PANE& EDA_PANE::Messages ( )
inline

Turn *this into a messages pane for KiCad.

Definition at line 555 of file eda_base_frame.h.

556  {
557  CaptionVisible( false );
558  BottomDockable( true );
559  DockFixed( true );
560  Movable( false );
561  Resizable( true ); // expand to fit available space
562  return *this;
563  }

◆ Palette()

EDA_PANE& EDA_PANE::Palette ( )
inline

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

Definition at line 533 of file eda_base_frame.h.

534  {
535  CaptionVisible( true );
536  PaneBorder( true );
537  return *this;
538  }

◆ VToolbar()

EDA_PANE& EDA_PANE::VToolbar ( )
inline

Turn *this into a vertical toolbar for KiCad.

Definition at line 519 of file eda_base_frame.h.

520  {
521  SetFlag( optionToolbar, true );
522  CaptionVisible( false );
523  LeftDockable().RightDockable();
524  DockFixed( true );
525  Movable( false );
526  Resizable( true ); // expand to fit available space
527  return *this;
528  }

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