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

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 496 of file eda_base_frame.h.

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

Member Function Documentation

◆ Canvas()

EDA_PANE& EDA_PANE::Canvas ( )
inline

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

Definition at line 544 of file eda_base_frame.h.

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

◆ HToolbar()

EDA_PANE& EDA_PANE::HToolbar ( )
inline

Turn *this to a horizontal toolbar for KiCad.

Definition at line 506 of file eda_base_frame.h.

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

◆ Messages()

EDA_PANE& EDA_PANE::Messages ( )
inline

Turn *this into a messages pane for KiCad.

Definition at line 556 of file eda_base_frame.h.

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

◆ Palette()

EDA_PANE& EDA_PANE::Palette ( )
inline

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

Definition at line 534 of file eda_base_frame.h.

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

◆ VToolbar()

EDA_PANE& EDA_PANE::VToolbar ( )
inline

Turn *this into a vertical toolbar for KiCad.

Definition at line 520 of file eda_base_frame.h.

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

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