diff options
Diffstat (limited to 'sip/tqt/tqsettings.sip')
| -rw-r--r-- | sip/tqt/tqsettings.sip | 163 |
1 files changed, 163 insertions, 0 deletions
diff --git a/sip/tqt/tqsettings.sip b/sip/tqt/tqsettings.sip new file mode 100644 index 0000000..3831bfd --- /dev/null +++ b/sip/tqt/tqsettings.sip @@ -0,0 +1,163 @@ +// This is the SIP interface definition for TQSettings. +// +// Copyright (c) 2007 +// Riverbank Computing Limited <info@riverbankcomputing.co.uk> +// +// This file is part of PyTQt. +// +// This copy of PyTQt 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, or (at your option) any later +// version. +// +// PyTQt is supplied 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 +// PyTQt; see the file LICENSE. If not, write to the Free Software Foundation, +// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + + +%ExportedDoc +<Sect2><Title>TQSettings (TQt v3+)</Title> +<FuncSynopsis> + <FuncDef>bool <Function>readBoolEntry</Function></FuncDef> + <ParamDef>const TQString &<Parameter>key</Parameter></ParamDef> + <ParamDef>bool <Parameter>def</Parameter> = 0</ParamDef> + <ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef> +</FuncSynopsis> +<Para> +The <Literal>ok</Literal> is not passed and the returned value is a tuple of +the <Literal>bool</Literal> result and the <Literal>ok</Literal> flag. +</Para> + +<FuncSynopsis> +<FuncDef>double <Function>readDoubleEntry</Function></FuncDef> + <ParamDef>const TQString &<Parameter>key</Parameter></ParamDef> + <ParamDef>double <Parameter>def</Parameter> = 0</ParamDef> + <ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef> +</FuncSynopsis> +<Para> +The <Literal>ok</Literal> is not passed and the returned value is a tuple of +the <Literal>double</Literal> result and the <Literal>ok</Literal> flag. +</Para> + +<FuncSynopsis> +<FuncDef>TQString <Function>readEntry</Function></FuncDef> + <ParamDef>const TQString &<Parameter>key</Parameter></ParamDef> + <ParamDef>const TQString &<Parameter>def</Parameter> = TQString::null</ParamDef> + <ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef> +</FuncSynopsis> +<Para> +The <Literal>ok</Literal> is not passed and the returned value is a tuple of +the <Literal>TQString</Literal> result and the <Literal>ok</Literal> flag. +</Para> + +<FuncSynopsis> +<FuncDef>TQStringList <Function>readListEntry</Function></FuncDef> + <ParamDef>const TQString &<Parameter>key</Parameter></ParamDef> + <ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef> +</FuncSynopsis> +<Para> +The <Literal>ok</Literal> is not passed and the returned value is a tuple of +the <Literal>TQStringList</Literal> result and the <Literal>ok</Literal> flag. +</Para> + +<FuncSynopsis> +<FuncDef>TQStringList <Function>readListEntry</Function></FuncDef> + <ParamDef>const TQString &<Parameter>key</Parameter></ParamDef> + <ParamDef>const TQChar &<Parameter>separator</Parameter></ParamDef> + <ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef> +</FuncSynopsis> +<Para> +The <Literal>ok</Literal> is not passed and the returned value is a tuple of +the <Literal>TQStringList</Literal> result and the <Literal>ok</Literal> flag. +</Para> + +<FuncSynopsis> +<FuncDef>int <Function>readNumEntry</Function></FuncDef> + <ParamDef>const TQString &<Parameter>key</Parameter></ParamDef> + <ParamDef>int <Parameter>def</Parameter> = 0</ParamDef> + <ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef> +</FuncSynopsis> +<Para> +The <Literal>ok</Literal> is not passed and the returned value is a tuple of +the <Literal>int</Literal> result and the <Literal>ok</Literal> flag. +</Para> + +<FuncSynopsis> + <FuncDef>bool <Function>writeEntry</Function></FuncDef> + <ParamDef>const TQString &<Parameter>key</Parameter></ParamDef> + <ParamDef>bool <Parameter>value</Parameter></ParamDef> +</FuncSynopsis> +<Para> +Not implemented. +</Para> +</Sect2> +%End + + +class TQSettings +{ +%TypeHeaderCode +#include <tqsettings.h> +%End + +public: + enum Format { + Native, + Ini + }; + + enum System { + Unix, + Windows, + Mac + }; + + enum Scope { + User, + Global + }; + + TQSettings(); + TQSettings(Format); + +// bool writeEntry(const TQString &,bool); + bool writeEntry(const TQString &,int /Constrained/); + bool writeEntry(const TQString &,double); +// bool writeEntry(const TQString &,const char *); + bool writeEntry(const TQString &,const TQString &); + bool writeEntry(const TQString &,const TQStringList &); + bool writeEntry(const TQString &,const TQStringList &,const TQChar &); + + TQStringList entryList(const TQString &) const; + TQStringList subkeyList(const TQString &) const; + + TQStringList readListEntry(const TQString &,bool * = 0); + TQStringList readListEntry(const TQString &,const TQChar &,bool * = 0); + TQString readEntry(const TQString &,const TQString & = TQString::null, + bool * = 0); + int readNumEntry(const TQString &,int = 0,bool * = 0); + double readDoubleEntry(const TQString &,double = 0,bool * = 0); + bool readBoolEntry(const TQString &,bool = 0,bool * = 0); + + bool removeEntry(const TQString &); + + void insertSearchPath(System,const TQString &); + void removeSearchPath(System,const TQString &); + + void setPath(const TQString &,const TQString &,Scope = Global); + + void beginGroup(const TQString &); + void endGroup(); + void resetGroup(); + TQString group() const; + + bool sync(); + +private: + TQSettings(const TQSettings &); +}; |