PLUGIN_FILE_DESC Struct Reference

Container that describes file type info. More...

#include <plugin_file_desc.h>

Public Member Functions
	PLUGIN_FILE_DESC (const wxString &aDescription, const std::vector< std::string > &aFileExtensions, const std::vector< std::string > &aExtsInFolder={}, bool aIsFile=true)
	PLUGIN_FILE_DESC ()
wxString	FileFilter () const
	operator bool () const

Public Attributes
wxString	m_Description
	Description shown in the file picker dialog. More...
std::vector< std::string >	m_FileExtensions
	Filter used for file pickers if m_IsFile is true. More...
std::vector< std::string >	m_ExtensionsInDir
	In case of folders: extensions of files inside. More...
bool	m_IsFile
	Whether the library is a folder or a file. More...

Detailed Description

Container that describes file type info.

Definition at line 34 of file plugin_file_desc.h.

Constructor & Destructor Documentation

PLUGIN_FILE_DESC() [1/2]

PLUGIN_FILE_DESC::PLUGIN_FILE_DESC ( const wxString &  aDescription, const std::vector< std::string > &  aFileExtensions, const std::vector< std::string > &  aExtsInFolder = {}, bool  aIsFile = true  )

inline

Definition at line 41 of file plugin_file_desc.h.

PLUGIN_FILE_DESC() [2/2]

PLUGIN_FILE_DESC::PLUGIN_FILE_DESC ( )

inline

Definition at line 49 of file plugin_file_desc.h.

Member Function Documentation

FileFilter()

wxString PLUGIN_FILE_DESC::FileFilter

(

)

const

Returns

translated description + wildcards string for file dialogs.

Definition at line 29 of file plugin_file_desc.cpp.

References AddFileExtListToFilter(), m_Description, and m_FileExtensions.

Referenced by PANEL_FP_LIB_TABLE::browseLibrariesHandler(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), SYMBOL_EDIT_FRAME::ImportSymbol(), SCH_EDIT_FRAME::OnImportProject(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), and PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE().

operator bool()

PLUGIN_FILE_DESC::operator bool ( ) const

inline

Definition at line 56 of file plugin_file_desc.h.

References m_Description.

Member Data Documentation

m_Description

wxString PLUGIN_FILE_DESC::m_Description

Description shown in the file picker dialog.

Definition at line 36 of file plugin_file_desc.h.

Referenced by FileFilter(), and operator bool().

m_ExtensionsInDir

std::vector<std::string> PLUGIN_FILE_DESC::m_ExtensionsInDir

In case of folders: extensions of files inside.

Definition at line 38 of file plugin_file_desc.h.

Referenced by PLUGIN::CanReadFootprintLib(), and SCH_PLUGIN::CanReadLibrary().

m_FileExtensions

std::vector<std::string> PLUGIN_FILE_DESC::m_FileExtensions

Filter used for file pickers if m_IsFile is true.

Definition at line 37 of file plugin_file_desc.h.

Referenced by AskLoadBoardFileName(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PLUGIN::CanReadBoard(), PLUGIN::CanReadFootprint(), PLUGIN::CanReadFootprintLib(), SCH_PLUGIN::CanReadLibrary(), SCH_PLUGIN::CanReadSchematicFile(), FileFilter(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), SYMBOL_EDIT_FRAME::ImportSymbol(), SCH_EDIT_FRAME::OnImportProject(), and PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE().

m_IsFile

bool PLUGIN_FILE_DESC::m_IsFile

Whether the library is a folder or a file.

Definition at line 39 of file plugin_file_desc.h.

Referenced by PANEL_FP_LIB_TABLE::browseLibrariesHandler(), PLUGIN::CanReadFootprintLib(), SCH_PLUGIN::CanReadLibrary(), and PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE().

---

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

• plugin_file_desc.h
• plugin_file_desc.cpp