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...
 
EDA_PANEInfoBar ()
 Turn *this into a infobar 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 its 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 796 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ EDA_PANE()

EDA_PANE::EDA_PANE ( )
inline

Definition at line 799 of file eda_base_frame.h.

800 {
801 Gripper( false );
802 CloseButton( false );
803 PaneBorder( false );
804 }

Member Function Documentation

◆ Canvas()

EDA_PANE & EDA_PANE::Canvas ( )
inline

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

Definition at line 847 of file eda_base_frame.h.

848 {
849 CaptionVisible( false );
850 Layer( 0 );
851 PaneBorder( true );
852 Resizable( true ); // expand to fit available space
853 return *this;
854 }

◆ HToolbar()

EDA_PANE & EDA_PANE::HToolbar ( )
inline

Turn *this to a horizontal toolbar for KiCad.

Definition at line 809 of file eda_base_frame.h.

810 {
811 SetFlag( optionToolbar, true );
812 CaptionVisible( false );
813 TopDockable().BottomDockable();
814 DockFixed( true );
815 Movable( false );
816 Resizable( true ); // expand to fit available space
817 return *this;
818 }

◆ InfoBar()

EDA_PANE & EDA_PANE::InfoBar ( )
inline

Turn *this into a infobar for KiCad.

Definition at line 872 of file eda_base_frame.h.

873 {
874 CaptionVisible( false );
875 Movable( false );
876 Resizable( true );
877 PaneBorder( false );
878 DockFixed( true );
879 return *this;
880 }

◆ Messages()

EDA_PANE & EDA_PANE::Messages ( )
inline

Turn *this into a messages pane for KiCad.

Definition at line 859 of file eda_base_frame.h.

860 {
861 CaptionVisible( false );
862 BottomDockable( true );
863 DockFixed( true );
864 Movable( false );
865 Resizable( true ); // expand to fit available space
866 return *this;
867 }

◆ Palette()

EDA_PANE & EDA_PANE::Palette ( )
inline

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

Definition at line 837 of file eda_base_frame.h.

838 {
839 CaptionVisible( true );
840 PaneBorder( true );
841 return *this;
842 }

◆ VToolbar()

EDA_PANE & EDA_PANE::VToolbar ( )
inline

Turn *this into a vertical toolbar for KiCad.

Definition at line 823 of file eda_base_frame.h.

824 {
825 SetFlag( optionToolbar, true );
826 CaptionVisible( false );
827 LeftDockable().RightDockable();
828 DockFixed( true );
829 Movable( false );
830 Resizable( true ); // expand to fit available space
831 return *this;
832 }

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