• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdeaccessibility API Reference
  • KDE Home
  • Contact Us
 

jovie

Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KttsFilterConf Class Reference

#include <filterconf.h>

Inheritance diagram for KttsFilterConf:
Inheritance graph
[legend]

Public Slots

void configChanged ()
 

Signals

void changed (bool)
 

Public Member Functions

 KttsFilterConf (QWidget *parent, const QVariantList &)
 
virtual ~KttsFilterConf ()
 
virtual void defaults ()
 
virtual bool isSBD ()
 
virtual void load (KConfig *config, const QString &configGroup)
 
virtual void save (KConfig *config, const QString &configGroup)
 
virtual bool supportsMultiInstance ()
 
virtual QString userPlugInName ()
 

Static Public Member Functions

static QString realFilePath (const QString &filename)
 

Protected Member Functions

QString getLocation (const QString &name)
 

Protected Attributes

QStringList m_path
 

Detailed Description

Definition at line 36 of file filterconf.h.

Constructor & Destructor Documentation

KttsFilterConf::KttsFilterConf ( QWidget *  parent,
const QVariantList &   
)
explicit

Constructor.

Definition at line 44 of file filterconf.cpp.

KttsFilterConf::~KttsFilterConf ( )
virtual

Destructor.

Definition at line 55 of file filterconf.cpp.

Member Function Documentation

void KttsFilterConf::changed ( bool  )
signal

This signal indicates that the configuration has been changed.

It should be emitted whenever user changes something in the configuration widget.

void KttsFilterConf::configChanged ( )
inlineslot

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 changed signal.

Definition at line 122 of file filterconf.h.

void KttsFilterConf::defaults ( )
virtual

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.

Reimplemented in StringReplacerConf, TalkerChooserConf, and XmlTransformerConf.

Definition at line 97 of file filterconf.cpp.

QString KttsFilterConf::getLocation ( const QString &  name)
protected

Searches the $PATH variable for any file.

Return the full path to any program in the $PATH environmental variable.

If that file exists in the PATH, or is contained in any directory in the PATH, it returns the full path to it.

Parameters
nameThe name of the file to search for.
Returns
The path to the file on success, a blank QString if it is not found.
Parameters
nameThe name of the file to search for.
Returns
The path to the file on success, a blank QString if it is not found.

Definition at line 130 of file filterconf.cpp.

bool KttsFilterConf::isSBD ( )
virtual

Returns True if this filter is a Sentence Boundary Detector.

Returns
True if this filter is a SBD.

Definition at line 122 of file filterconf.cpp.

void KttsFilterConf::load ( KConfig *  config,
const QString &  configGroup 
)
virtual

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.

Parameters
configPointer to a KConfig object.
configGroupCall config->setGroup with this argument before loading your configuration.

When a plugin is first added to KTTSMGR, load will be called with a Null 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.

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.

Parameters
configPointer to a KConfig object.
configGroupCall config->setGroup with this argument before loading your configuration.

Reimplemented in StringReplacerConf, TalkerChooserConf, and XmlTransformerConf.

Definition at line 72 of file filterconf.cpp.

QString KttsFilterConf::realFilePath ( const QString &  filename)
static

Definition at line 154 of file filterconf.cpp.

void KttsFilterConf::save ( KConfig *  config,
const QString &  configGroup 
)
virtual

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.

Parameters
configPointer to a KConfig object.
configGroupCall config->setGroup with this argument before saving your configuration.

Reimplemented in StringReplacerConf, TalkerChooserConf, and XmlTransformerConf.

Definition at line 86 of file filterconf.cpp.

bool KttsFilterConf::supportsMultiInstance ( )
virtual

Indicates whether the plugin supports multiple instances.

Return False if only one instance of the plugin can be configured.

Returns
True if multiple instances are possible.

Reimplemented in StringReplacerConf, TalkerChooserConf, and XmlTransformerConf.

Definition at line 106 of file filterconf.cpp.

QString KttsFilterConf::userPlugInName ( )
virtual

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.

Returns
Filter instance name.

Reimplemented in StringReplacerConf, TalkerChooserConf, and XmlTransformerConf.

Definition at line 116 of file filterconf.cpp.

Member Data Documentation

QStringList KttsFilterConf::m_path
protected

The system path in a QStringList.

Definition at line 145 of file filterconf.h.


The documentation for this class was generated from the following files:
  • filterconf.h
  • filterconf.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:32:26 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

jovie

Skip menu "jovie"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdeaccessibility API Reference

Skip menu "kdeaccessibility API Reference"
  • jovie

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal