IO_BASE::IO_FILE_DESC Struct Reference

Container that describes file type info. More...

#include <io_base.h>

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

Public Attributes
wxString	m_Description
	Description shown in the file picker dialog.
std::vector< std::string >	m_FileExtensions
	Filter used for file pickers if m_IsFile is true.
std::vector< std::string >	m_ExtensionsInDir
bool	m_IsFile
	Whether the library is a folder or a file.
bool	m_CanRead
	Whether the IO can read this file type.
bool	m_CanWrite
	Whether the IO can write this file type.

Detailed Description

Container that describes file type info.

Definition at line 44 of file io_base.h.

Constructor & Destructor Documentation

IO_FILE_DESC() [1/2]

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

inline

Definition at line 57 of file io_base.h.

Referenced by IO_FILE_DESC().

IO_FILE_DESC() [2/2]

IO_BASE::IO_FILE_DESC::IO_FILE_DESC ( )

inline

Definition at line 66 of file io_base.h.

References IO_FILE_DESC().

Member Function Documentation

FileFilter()

wxString IO_BASE::IO_FILE_DESC::FileFilter

(

)

const

Returns

translated description + wildcards string for file dialogs.

Definition at line 40 of file io_base.cpp.

References AddFileExtListToFilter(), m_Description, and m_FileExtensions.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), DESIGN_BLOCK_LIB_TABLE_GRID_DATA_MODEL::getFileTypes(), FP_LIB_TABLE_GRID_DATA_MODEL::getFileTypes(), SYMBOL_LIB_TABLE_GRID_DATA_MODEL::getFileTypes(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), SYMBOL_EDIT_FRAME::ImportSymbol(), and SCH_EDIT_FRAME::OnImportProject().

operator bool()

IO_BASE::IO_FILE_DESC::operator bool ( ) const

inline

Definition at line 73 of file io_base.h.

References m_Description.

Member Data Documentation

m_CanRead

bool IO_BASE::IO_FILE_DESC::m_CanRead

Whether the IO can read this file type.

Definition at line 54 of file io_base.h.

Referenced by AskLoadBoardFileName(), and SCH_EDIT_FRAME::OnImportProject().

m_CanWrite

bool IO_BASE::IO_FILE_DESC::m_CanWrite

Whether the IO can write this file type.

Definition at line 55 of file io_base.h.

m_Description

wxString IO_BASE::IO_FILE_DESC::m_Description

Description shown in the file picker dialog.

Definition at line 46 of file io_base.h.

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

m_ExtensionsInDir

std::vector<std::string> IO_BASE::IO_FILE_DESC::m_ExtensionsInDir

Definition at line 52 of file io_base.h.

Referenced by IO_BASE::CanReadLibrary().

m_FileExtensions

std::vector<std::string> IO_BASE::IO_FILE_DESC::m_FileExtensions

Filter used for file pickers if m_IsFile is true.

In case of folders: extensions of files inside.

Definition at line 49 of file io_base.h.

Referenced by AskLoadBoardFileName(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PCB_IO::CanReadBoard(), PCB_IO::CanReadFootprint(), IO_BASE::CanReadLibrary(), SCH_IO::CanReadSchematicFile(), FileFilter(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), SYMBOL_EDIT_FRAME::ImportSymbol(), and SCH_EDIT_FRAME::OnImportProject().

m_IsFile

bool IO_BASE::IO_FILE_DESC::m_IsFile

Whether the library is a folder or a file.

Definition at line 53 of file io_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), IO_BASE::CanReadLibrary(), DESIGN_BLOCK_LIB_TABLE_GRID_DATA_MODEL::getFileTypes(), FP_LIB_TABLE_GRID_DATA_MODEL::getFileTypes(), and SYMBOL_LIB_TABLE_GRID_DATA_MODEL::getFileTypes().

---

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

• io_base.h
• io_base.cpp