KiCad PCB EDA Suite
Loading...
Searching...
No Matches
plugin_file_desc.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef PLUGIN_FILE_DESC_H_
25#define PLUGIN_FILE_DESC_H_
26
27#include <vector>
28#include <string>
29#include <wx/string.h>
30
35{
36 wxString m_Description;
37 std::vector<std::string> m_FileExtensions;
38 std::vector<std::string> m_ExtensionsInDir;
39 bool m_IsFile;
40
41 PLUGIN_FILE_DESC( const wxString& aDescription, const std::vector<std::string>& aFileExtensions,
42 const std::vector<std::string>& aExtsInFolder = {}, bool aIsFile = true ) :
43 m_Description( aDescription ),
44 m_FileExtensions( aFileExtensions ), m_ExtensionsInDir( aExtsInFolder ),
45 m_IsFile( aIsFile )
46 {
47 }
48
49 PLUGIN_FILE_DESC() : PLUGIN_FILE_DESC( wxEmptyString, {} ) {}
50
54 wxString FileFilter() const;
55
56 operator bool() const { return !m_Description.empty(); }
57};
58
59#endif // PLUGIN_FILE_DESC_H_
Container that describes file type info.
wxString FileFilter() const
std::vector< std::string > m_ExtensionsInDir
In case of folders: extensions of files inside.
bool m_IsFile
Whether the library is a folder or a file.
std::vector< std::string > m_FileExtensions
Filter used for file pickers if m_IsFile is true.
wxString m_Description
Description shown in the file picker dialog.
PLUGIN_FILE_DESC(const wxString &aDescription, const std::vector< std::string > &aFileExtensions, const std::vector< std::string > &aExtsInFolder={}, bool aIsFile=true)