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

Constructor & Destructor Documentation

EDA_PANE::EDA_PANE ( )
inline

Definition at line 441 of file eda_base_frame.h.

442  {
443  Gripper( false );
444  CloseButton( false );
445  PaneBorder( false );
446  }

Member Function Documentation

EDA_PANE& EDA_PANE::Canvas ( )
inline

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

Definition at line 493 of file eda_base_frame.h.

Referenced by EVT_TOOL_RANGE(), and EVT_UPDATE_UI_RANGE().

494  {
495  CaptionVisible( false );
496  Layer( 0 );
497  PaneBorder( true );
498  Resizable( true ); // expand to fit available space
499  return *this;
500  }
EDA_PANE& EDA_PANE::HToolbar ( )
inline

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

Definition at line 452 of file eda_base_frame.h.

453  {
454  SetFlag( optionToolbar, true );
455  CaptionVisible( false );
456  TopDockable().BottomDockable();
457  DockFixed( true );
458  Movable( false );
459  Resizable( true ); // expand to fit available space
460  return *this;
461  }
EDA_PANE& EDA_PANE::Messages ( )
inline

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

Definition at line 506 of file eda_base_frame.h.

507  {
508  CaptionVisible( false );
509  BottomDockable( true );
510  DockFixed( true );
511  Movable( false );
512  Resizable( true ); // expand to fit available space
513  return *this;
514  }
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 482 of file eda_base_frame.h.

483  {
484  CaptionVisible( true );
485  PaneBorder( true );
486  return *this;
487  }
EDA_PANE& EDA_PANE::VToolbar ( )
inline

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

Definition at line 467 of file eda_base_frame.h.

468  {
469  SetFlag( optionToolbar, true );
470  CaptionVisible( false );
471  LeftDockable().RightDockable();
472  DockFixed( true );
473  Movable( false );
474  Resizable( true ); // expand to fit available space
475  return *this;
476  }

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