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

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 433 of file eda_base_frame.h.

434  {
435  Gripper( false );
436  CloseButton( false );
437  PaneBorder( false );
438  }

Member Function Documentation

◆ Canvas()

EDA_PANE& EDA_PANE::Canvas ( )
inline

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

Definition at line 481 of file eda_base_frame.h.

482  {
483  CaptionVisible( false );
484  Layer( 0 );
485  PaneBorder( true );
486  Resizable( true ); // expand to fit available space
487  return *this;
488  }

Referenced by EVT_TOOL_RANGE(), and SCH_EDIT_FRAME::SCH_EDIT_FRAME().

◆ HToolbar()

EDA_PANE& EDA_PANE::HToolbar ( )
inline

Turn *this to a horizontal toolbar for KiCad.

Definition at line 443 of file eda_base_frame.h.

444  {
445  SetFlag( optionToolbar, true );
446  CaptionVisible( false );
447  TopDockable().BottomDockable();
448  DockFixed( true );
449  Movable( false );
450  Resizable( true ); // expand to fit available space
451  return *this;
452  }

◆ Messages()

EDA_PANE& EDA_PANE::Messages ( )
inline

Turn *this into a messages pane for KiCad.

Definition at line 493 of file eda_base_frame.h.

494  {
495  CaptionVisible( false );
496  BottomDockable( true );
497  DockFixed( true );
498  Movable( false );
499  Resizable( true ); // expand to fit available space
500  return *this;
501  }

◆ Palette()

EDA_PANE& EDA_PANE::Palette ( )
inline

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

Definition at line 471 of file eda_base_frame.h.

472  {
473  CaptionVisible( true );
474  PaneBorder( true );
475  return *this;
476  }

◆ VToolbar()

EDA_PANE& EDA_PANE::VToolbar ( )
inline

Turn *this into a vertical toolbar for KiCad.

Definition at line 457 of file eda_base_frame.h.

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

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