summaryrefslogtreecommitdiff
path: root/include/tool/tool_settings.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/tool/tool_settings.h')
-rw-r--r--include/tool/tool_settings.h80
1 files changed, 80 insertions, 0 deletions
diff --git a/include/tool/tool_settings.h b/include/tool/tool_settings.h
new file mode 100644
index 0000000..64d2612
--- /dev/null
+++ b/include/tool/tool_settings.h
@@ -0,0 +1,80 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2015 CERN
+ * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+
+#ifndef __TOOL_SETTINGS_H
+#define __TOOL_SETTINGS_H
+
+#include <wx/confbase.h>
+
+/**
+ * Class TOOL_SETTINGS
+ *
+ * Manages persistent settings for a tool (just a simple wrapper to wxConfigBase)
+ */
+class TOOL_BASE;
+
+class TOOL_SETTINGS
+{
+ public:
+ TOOL_SETTINGS( TOOL_BASE* aTool = NULL );
+ ~TOOL_SETTINGS();
+
+ template<class T>
+ T Get( const wxString& aName, T aDefaultValue ) const
+ {
+ wxConfigBase* config = getConfigBase();
+
+ if( !config )
+ return aDefaultValue;
+
+ T tmp = aDefaultValue;
+
+ config->Read( getKeyName( aName ), &tmp );
+ return tmp;
+ }
+
+ template<class T>
+ void Set( const wxString& aName, const T &aValue )
+ {
+ wxConfigBase* config = getConfigBase();
+
+ if( !config )
+ return;
+
+ config->Write( getKeyName( aName ), aValue );
+ }
+
+ private:
+ wxString getKeyName( const wxString& aEntryName ) const;
+
+ ///> Returns pointer to currently used wxConfigBase. It might be NULL, if there is no
+ ///> TOOL_BASE assigned.
+ wxConfigBase* getConfigBase() const;
+
+ TOOL_BASE* m_tool;
+
+};
+
+#endif