PROJECT_TREE This is the class to show (as a tree) the files in the project directory. More...

#include <project_tree.h>

Inheritance diagram for PROJECT_TREE:

Public Member Functions
PROJECT_TREE_PANE *	GetProjectTreePane () const

	PROJECT_TREE (PROJECT_TREE_PANE *parent)

	~PROJECT_TREE ()

void	LoadIcons ()

Private Member Functions
int	OnCompareItems (const wxTreeItemId &item1, const wxTreeItemId &item2) override

Private Attributes
PROJECT_TREE_PANE *	m_projectTreePane

wxImageList *	m_imageList

Detailed Description

PROJECT_TREE This is the class to show (as a tree) the files in the project directory.

Definition at line 38 of file project_tree.h.

Constructor & Destructor Documentation

◆ PROJECT_TREE()

PROJECT_TREE::PROJECT_TREE ( PROJECT_TREE_PANE * parent )

Definition at line 44 of file project_tree.cpp.

 :
 wxTreeCtrl( parent, ID_PROJECT_TREE, wxDefaultPosition, wxDefaultSize,
 PLATFORM_STYLE | wxTR_HAS_BUTTONS | wxTR_MULTIPLE, wxDefaultValidator,
 wxT( "EDATreeCtrl" ) ),
 m_imageList( nullptr )
{
 m_projectTreePane = parent;
 
 // Make sure the GUI font scales properly on GTK
 SetFont( KIUI::GetControlFont( this ) );
 
 LoadIcons();
}

References KIUI::GetControlFont(), LoadIcons(), and m_projectTreePane.

◆ ~PROJECT_TREE()

PROJECT_TREE::~PROJECT_TREE ( )

Definition at line 59 of file project_tree.cpp.

{
 delete m_imageList;
}

References m_imageList.

Member Function Documentation

◆ GetProjectTreePane()

PROJECT_TREE_PANE * PROJECT_TREE::GetProjectTreePane ( ) const

inline

Definition at line 47 of file project_tree.h.

47{ return m_projectTreePane; }

References m_projectTreePane.

◆ LoadIcons()

void PROJECT_TREE::LoadIcons ( )

Definition at line 65 of file project_tree.cpp.

{
 delete m_imageList;
 
 // icons size is not know (depending on they are built)
 // so get it:
 wxSize iconsize;
 wxBitmap dummy = KiBitmap( BITMAPS::icon_eeschema_24 );
 iconsize.x = dummy.GetWidth();
 iconsize.y = dummy.GetHeight();
 
 // Make an image list containing small icons
 m_imageList = new wxImageList( iconsize.x, iconsize.y, true,
 static_cast<int>( TREE_FILE_TYPE::MAX ) );
 
 m_imageList->Add( KiBitmap( BITMAPS::project ) ); // TREE_LEGACY_PROJECT
 m_imageList->Add( KiBitmap( BITMAPS::project_kicad ) ); // TREE_JSON_PROJECT
 m_imageList->Add( KiBitmap( BITMAPS::icon_eeschema_24 ) ); // TREE_LEGACY_SCHEMATIC
 m_imageList->Add( KiBitmap( BITMAPS::icon_eeschema_24 ) ); // TREE_SEXPR_SCHEMATIC
 m_imageList->Add( KiBitmap( BITMAPS::icon_pcbnew_24 ) ); // TREE_LEGACY_PCB
 m_imageList->Add( KiBitmap( BITMAPS::icon_pcbnew_24 ) ); // TREE_SEXPR_PCB
 m_imageList->Add( KiBitmap( BITMAPS::icon_gerbview_24 ) ); // TREE_GERBER
 m_imageList->Add( KiBitmap( BITMAPS::file_gerber_job ) ); // TREE_GERBER_JOB_FILE (.gbrjob)
 m_imageList->Add( KiBitmap( BITMAPS::file_html ) ); // TREE_HTML
 m_imageList->Add( KiBitmap( BITMAPS::file_pdf ) ); // TREE_PDF
 m_imageList->Add( KiBitmap( BITMAPS::editor ) ); // TREE_TXT
 m_imageList->Add( KiBitmap( BITMAPS::editor ) ); // TREE_MD
 m_imageList->Add( KiBitmap( BITMAPS::netlist ) ); // TREE_NET
 m_imageList->Add( KiBitmap( BITMAPS::unknown ) ); // TREE_UNKNOWN
 m_imageList->Add( KiBitmap( BITMAPS::directory ) ); // TREE_DIRECTORY
 m_imageList->Add( KiBitmap( BITMAPS::icon_cvpcb_24 ) ); // TREE_CMP_LINK
 m_imageList->Add( KiBitmap( BITMAPS::tools ) ); // TREE_REPORT
 m_imageList->Add( KiBitmap( BITMAPS::file_pos ) ); // TREE_POS
 m_imageList->Add( KiBitmap( BITMAPS::file_drl ) ); // TREE_DRILL
 m_imageList->Add( KiBitmap( BITMAPS::file_drl ) ); // TREE_DRILL_NC (similar TREE_DRILL)
 m_imageList->Add( KiBitmap( BITMAPS::file_drl ) ); // TREE_DRILL_XNC (similar TREE_DRILL)
 m_imageList->Add( KiBitmap( BITMAPS::file_svg ) ); // TREE_SVG
 m_imageList->Add( KiBitmap( BITMAPS::icon_pagelayout_editor_24 ) ); // TREE_PAGE_LAYOUT_DESCR
 m_imageList->Add( KiBitmap( BITMAPS::module ) ); // TREE_FOOTPRINT_FILE
 m_imageList->Add( KiBitmap( BITMAPS::library ) ); // TREE_SCHEMATIC_LIBFILE
 m_imageList->Add( KiBitmap( BITMAPS::library ) ); // TREE_SEXPR_SYMBOL_LIB_FILE
 m_imageList->Add( KiBitmap( BITMAPS::editor ) ); // DESIGN_RULES
 m_imageList->Add( KiBitmap( BITMAPS::zip ) ); // ZIP_ARCHIVE
 
 SetImageList( m_imageList );
}

References directory, dummy, editor, file_drl, file_gerber_job, file_html, file_pdf, file_pos, file_svg, icon_cvpcb_24, icon_eeschema_24, icon_gerbview_24, icon_pagelayout_editor_24, icon_pcbnew_24, KiBitmap(), library, m_imageList, MAX, module, netlist, project, project_kicad, tools, unknown, and zip.

Referenced by PROJECT_TREE_PANE::onThemeChanged(), and PROJECT_TREE().

◆ OnCompareItems()

int PROJECT_TREE::OnCompareItems	(	const wxTreeItemId &	item1,
		const wxTreeItemId &	item2
	)

overrideprivate

Definition at line 113 of file project_tree.cpp.

{
 PROJECT_TREE_ITEM* myitem1 = (PROJECT_TREE_ITEM*) GetItemData( item1 );
 PROJECT_TREE_ITEM* myitem2 = (PROJECT_TREE_ITEM*) GetItemData( item2 );
 
 if( !myitem1 || !myitem2 )
 return 0;
 
 if( myitem1->GetType() == TREE_FILE_TYPE::DIRECTORY
 && myitem2->GetType() != TREE_FILE_TYPE::DIRECTORY )
 return -1;
 
 if( myitem2->GetType() == TREE_FILE_TYPE::DIRECTORY
 && myitem1->GetType() != TREE_FILE_TYPE::DIRECTORY )
 return 1;
 
 if( myitem1->IsRootFile() && !myitem2->IsRootFile() )
 return -1;
 
 if( myitem2->IsRootFile() && !myitem1->IsRootFile() )
 return 1;
 
 return myitem1->GetFileName().CmpNoCase( myitem2->GetFileName() );
}

References DIRECTORY, PROJECT_TREE_ITEM::GetFileName(), PROJECT_TREE_ITEM::GetType(), and PROJECT_TREE_ITEM::IsRootFile().

Member Data Documentation

◆ m_imageList

wxImageList* PROJECT_TREE::m_imageList

private

Definition at line 44 of file project_tree.h.

Referenced by LoadIcons(), and ~PROJECT_TREE().

◆ m_projectTreePane

PROJECT_TREE_PANE* PROJECT_TREE::m_projectTreePane

private

Definition at line 43 of file project_tree.h.

Referenced by GetProjectTreePane(), and PROJECT_TREE().

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

Public Member Functions

Private Member Functions

Private Attributes