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

jovie

Public Member Functions | List of all members
XmlTransformerProc Class Reference

#include <xmltransformerproc.h>

Inheritance diagram for XmlTransformerProc:
Inheritance graph
[legend]

Public Member Functions

 XmlTransformerProc (QObject *parent, const QVariantList &args)
 
virtual ~XmlTransformerProc ()
 
virtual void ackFinished ()
 
virtual bool asyncConvert (const QString &inputText, TalkerCode *talkerCode, const QString &appId)
 
virtual QString convert (const QString &inputText, TalkerCode *talkerCode, const QString &appId)
 
virtual QString getOutput ()
 
virtual int getState ()
 
virtual bool init (KConfig *c, const QString &configGroup)
 
virtual void stopFiltering ()
 
virtual bool supportsAsync ()
 
virtual void waitForFinished ()
 
virtual bool wasModified ()
 
- Public Member Functions inherited from KttsFilterProc
 KttsFilterProc (QObject *parent, const QVariantList &)
 
virtual ~KttsFilterProc ()
 
virtual bool isSBD ()
 
virtual void setSbRegExp (const QString &re)
 

Additional Inherited Members

- Public Types inherited from KttsFilterProc
enum  FilterState { fsIdle = 0, fsFiltering = 1, fsStopping = 2, fsFinished = 3 }
 
- Signals inherited from KttsFilterProc
void error (bool keepGoing, const QString &msg)
 
void filteringFinished ()
 
void filteringStopped ()
 

Detailed Description

Definition at line 38 of file xmltransformerproc.h.

Constructor & Destructor Documentation

XmlTransformerProc::XmlTransformerProc ( QObject *  parent,
const QVariantList &  args 
)
explicit

Constructor.

Definition at line 49 of file xmltransformerproc.cpp.

XmlTransformerProc::~XmlTransformerProc ( )
virtual

Destructor.

Definition at line 58 of file xmltransformerproc.cpp.

Member Function Documentation

void XmlTransformerProc::ackFinished ( )
virtual

Acknowledges the finished filtering.

Reimplemented from KttsFilterProc.

Definition at line 325 of file xmltransformerproc.cpp.

bool XmlTransformerProc::asyncConvert ( const QString &  inputText,
TalkerCode *  talkerCode,
const QString &  appId 
)
virtual

Convert input.

Runs asynchronously.

Parameters
inputTextInput text.
talkerCodeTalkerCode structure for the talker that KTTSD intends to use for synthing the text. Useful for extracting hints about how to filter the text. For example, languageCode.
appIdThe DCOP appId of the application that queued the text. Also useful for hints about how to do the filtering.
Returns
False if the filter cannot perform the conversion.

When conversion is completed, emits signal filteringFinished. Calling program may then call getOutput to retrieve converted text. Calling program must call ackFinished to acknowledge the conversion.

Write

Parameters
textto a temporary file.

Spawn an xsltproc process to apply our stylesheet to input file.

Reimplemented from KttsFilterProc.

Definition at line 121 of file xmltransformerproc.cpp.

QString XmlTransformerProc::convert ( const QString &  inputText,
TalkerCode *  talkerCode,
const QString &  appId 
)
virtual

Convert input, returning output.

Parameters
inputTextInput text.
talkerCodeTalkerCode structure for the talker that KTTSD intends to use for synthing the text. Useful for extracting hints about how to filter the text. For example, languageCode.
appIdThe DCOP appId of the application that queued the text. Also useful for hints about how to do the filtering.

Reimplemented from KttsFilterProc.

Definition at line 101 of file xmltransformerproc.cpp.

QString XmlTransformerProc::getOutput ( )
virtual

Returns the filtered output.

Reimplemented from KttsFilterProc.

Definition at line 320 of file xmltransformerproc.cpp.

int XmlTransformerProc::getState ( )
virtual

Returns the state of the Filter.

Reimplemented from KttsFilterProc.

Definition at line 315 of file xmltransformerproc.cpp.

bool XmlTransformerProc::init ( KConfig *  c,
const QString &  configGroup 
)
virtual

Initialize the filter.

Parameters
cSettings object.
configGroupSettings Group.
Returns
False if filter is not ready to filter.

Note: The parameters are for reading from kttsdrc file. Plugins may wish to maintain separate configuration files of their own.

Reimplemented from KttsFilterProc.

Definition at line 65 of file xmltransformerproc.cpp.

void XmlTransformerProc::stopFiltering ( )
virtual

Stops filtering.

The filteringStopped signal will emit when filtering has in fact stopped and state returns to fsIdle;

Reimplemented from KttsFilterProc.

Definition at line 335 of file xmltransformerproc.cpp.

bool XmlTransformerProc::supportsAsync ( )
virtual

Returns True if the plugin supports asynchronous processing, i.e., supports asyncConvert method.

Returns
True if this plugin supports asynchronous processing.

If the plugin returns True, it must also implement getState . It must also emit filteringFinished when filtering is completed. If the plugin returns True, it must also implement stopFiltering . It must also emit filteringStopped when filtering has been stopped.

Reimplemented from KttsFilterProc.

Definition at line 90 of file xmltransformerproc.cpp.

void XmlTransformerProc::waitForFinished ( )
virtual

Waits for a previous call to asyncConvert to finish.

Reimplemented from KttsFilterProc.

Definition at line 296 of file xmltransformerproc.cpp.

bool XmlTransformerProc::wasModified ( )
virtual

Did this filter do anything? If the filter returns the input as output unmolested, it should return False when this method is called.

Reimplemented from KttsFilterProc.

Definition at line 345 of file xmltransformerproc.cpp.


The documentation for this class was generated from the following files:
  • xmltransformerproc.h
  • xmltransformerproc.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