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 ()
 Function HToolbar Turn *this to a horizontal toolbar for KiCad. More...
 
EDA_PANEVToolbar ()
 Function VToolbar Turn *this into a vertical toolbar for KiCad. More...
 
EDA_PANEPalette ()
 Function Palette Turn *this into a captioned palette suitable for a symbol tree, layers manager, etc. More...
 
EDA_PANECanvas ()
 Function Canvas Turn *this into an undecorated pane suitable for a drawing canvas. More...
 
EDA_PANEMessages ()
 Function Messages 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 442 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 445 of file eda_base_frame.h.

446  {
447  Gripper( false );
448  CloseButton( false );
449  PaneBorder( false );
450  }

Member Function Documentation

◆ Canvas()

EDA_PANE& EDA_PANE::Canvas ( )
inline

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

Definition at line 497 of file eda_base_frame.h.

498  {
499  CaptionVisible( false );
500  Layer( 0 );
501  PaneBorder( true );
502  Resizable( true ); // expand to fit available space
503  return *this;
504  }

Referenced by EVT_TOOL_RANGE(), and EVT_UPDATE_UI_RANGE().

◆ HToolbar()

EDA_PANE& EDA_PANE::HToolbar ( )
inline

Function HToolbar Turn *this to a horizontal toolbar for KiCad.

Definition at line 456 of file eda_base_frame.h.

457  {
458  SetFlag( optionToolbar, true );
459  CaptionVisible( false );
460  TopDockable().BottomDockable();
461  DockFixed( true );
462  Movable( false );
463  Resizable( true ); // expand to fit available space
464  return *this;
465  }

◆ Messages()

EDA_PANE& EDA_PANE::Messages ( )
inline

Function Messages Turn *this into a messages pane for KiCad.

Definition at line 510 of file eda_base_frame.h.

511  {
512  CaptionVisible( false );
513  BottomDockable( true );
514  DockFixed( true );
515  Movable( false );
516  Resizable( true ); // expand to fit available space
517  return *this;
518  }

◆ Palette()

EDA_PANE& EDA_PANE::Palette ( )
inline

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

Definition at line 486 of file eda_base_frame.h.

487  {
488  CaptionVisible( true );
489  PaneBorder( true );
490  return *this;
491  }

◆ VToolbar()

EDA_PANE& EDA_PANE::VToolbar ( )
inline

Function VToolbar Turn *this into a vertical toolbar for KiCad.

Definition at line 471 of file eda_base_frame.h.

472  {
473  SetFlag( optionToolbar, true );
474  CaptionVisible( false );
475  LeftDockable().RightDockable();
476  DockFixed( true );
477  Movable( false );
478  Resizable( true ); // expand to fit available space
479  return *this;
480  }

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