|
|
|
/***************************************************** vim:set ts=4 sw=4 sts=4:
|
|
|
|
Filter Configuration class.
|
|
|
|
This is the interface definition for text filter configuration dialogs.
|
|
|
|
-------------------
|
|
|
|
Copyright:
|
|
|
|
(C) 2005 by Gary Cramblitt <garycramblitt@comcast.net>
|
|
|
|
-------------------
|
|
|
|
Original author: Gary Cramblitt <garycramblitt@comcast.net>
|
|
|
|
|
|
|
|
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, write to the Free Software
|
|
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
******************************************************************************/
|
|
|
|
|
|
|
|
#ifndef _FILTERCONF_H_
|
|
|
|
#define _FILTERCONF_H_
|
|
|
|
|
|
|
|
// TQt includes.
|
|
|
|
#include <tqwidget.h>
|
|
|
|
|
|
|
|
// KDE includes.
|
|
|
|
#include <kconfig.h>
|
|
|
|
#include <kdebug.h>
|
|
|
|
#include <kdemacros.h>
|
|
|
|
#include "kdeexportfix.h"
|
|
|
|
|
|
|
|
class KDE_EXPORT KttsFilterConf : public TQWidget{
|
|
|
|
Q_OBJECT
|
|
|
|
|
|
|
|
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*/
|
|
|
|
KttsFilterConf( TQWidget *parent = 0, const char *name = 0);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Destructor
|
|
|
|
*/
|
|
|
|
virtual ~KttsFilterConf();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This method is invoked whenever the module should read its
|
|
|
|
* configuration (most of the times from a config file) and update the
|
|
|
|
* user interface. This happens when the user clicks the "Reset" button in
|
|
|
|
* the control center, to undo all of his changes and restore the currently
|
|
|
|
* valid settings. Note that KTTSMGR calls this when the plugin is
|
|
|
|
* loaded, so it not necessary to call it in your constructor.
|
|
|
|
* The plugin should read its configuration from the specified group
|
|
|
|
* in the specified config file.
|
|
|
|
* @param config Pointer to a KConfig object.
|
|
|
|
* @param configGroup Call config->setGroup with this argument before
|
|
|
|
* loading your configuration.
|
|
|
|
*
|
|
|
|
* When a plugin is first added to KTTSMGR, @e load will be called with
|
|
|
|
* a Null @e configGroup. In this case, the plugin will not have
|
|
|
|
* any instance-specific parameters to load, but it may still wish
|
|
|
|
* to load parameters that apply to all instances of the plugin.
|
|
|
|
*/
|
|
|
|
virtual void load(KConfig *config, const TQString &configGroup);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This function gets called when the user wants to save the settings in
|
|
|
|
* the user interface, updating the config files or wherever the
|
|
|
|
* configuration is stored. The method is called when the user clicks "Apply"
|
|
|
|
* or "Ok". The plugin should save its configuration in the specified
|
|
|
|
* group of the specified config file.
|
|
|
|
* @param config Pointer to a KConfig object.
|
|
|
|
* @param configGroup Call config->setGroup with this argument before
|
|
|
|
* saving your configuration.
|
|
|
|
*/
|
|
|
|
virtual void save(KConfig *config, const TQString &configGroup);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This function is called to set the settings in the module to sensible
|
|
|
|
* default values. It gets called when hitting the "Default" button. The
|
|
|
|
* default values should probably be the same as the ones the application
|
|
|
|
* uses when started without a config file. Note that defaults should
|
|
|
|
* be applied to the on-screen widgets; not to the config file.
|
|
|
|
*/
|
|
|
|
virtual void defaults();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Indicates whether the plugin supports multiple instances. Return
|
|
|
|
* False if only one instance of the plugin can be configured.
|
|
|
|
* @return True if multiple instances are possible.
|
|
|
|
*/
|
|
|
|
virtual bool supportsMultiInstance();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the name of the plugin. Displayed in Filters tab of KTTSMgr.
|
|
|
|
* If there can be more than one instance of a filter, it should return
|
|
|
|
* a unique name for each instance. The name should be translated for
|
|
|
|
* the user if possible. If the plugin is not correctly configured,
|
|
|
|
* return an empty string.
|
|
|
|
* @return Filter instance name.
|
|
|
|
*/
|
|
|
|
virtual TQString userPlugInName();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns True if this filter is a Sentence Boundary Detector.
|
|
|
|
* @return True if this filter is a SBD.
|
|
|
|
*/
|
|
|
|
virtual bool isSBD();
|
|
|
|
|
|
|
|
static TQString realFilePath(const TQString &filename);
|
|
|
|
|
|
|
|
public slots:
|
|
|
|
/**
|
|
|
|
* This slot is used internally when the configuration is changed. It is
|
|
|
|
* typically connected to signals from the widgets of the configuration
|
|
|
|
* and should emit the @ref changed signal.
|
|
|
|
*/
|
|
|
|
void configChanged(){
|
|
|
|
// kdDebug() << "KttsFilterConf::configChanged: Running"<< endl;
|
|
|
|
emit changed(true);
|
|
|
|
};
|
|
|
|
|
|
|
|
signals:
|
|
|
|
/**
|
|
|
|
* This signal indicates that the configuration has been changed.
|
|
|
|
* It should be emitted whenever user changes something in the configuration widget.
|
|
|
|
*/
|
|
|
|
void changed(bool);
|
|
|
|
|
|
|
|
protected:
|
|
|
|
/**
|
|
|
|
* Searches the $PATH variable for any file. If that file exists in the PATH, or
|
|
|
|
* is contained in any directory in the PATH, it returns the full path to it.
|
|
|
|
* @param name The name of the file to search for.
|
|
|
|
* @returns The path to the file on success, a blank TQString
|
|
|
|
* if its not found.
|
|
|
|
*/
|
|
|
|
TQString getLocation(const TQString &name);
|
|
|
|
|
|
|
|
/// The system path in a TQStringList.
|
|
|
|
TQStringList m_path;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif //_FILTERCONF_H_
|