• 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
AppData Class Reference

#include <appdata.h>

Public Member Functions

 AppData (const QString &appId)
 
 ~AppData ()
 
QString appId () const
 
QString applicationName () const
 
bool autoConfigureTalkersOn () const
 
KSpeech::JobPriority defaultPriority () const
 
QString defaultTalker () const
 
bool filteringOn () const
 
QString htmlFilterXsltFile () const
 
bool isApplicationPaused () const
 
bool isSystemManager () const
 
TJobListPtr jobList () const
 
int lastJobNum () const
 
QString sentenceDelimiter () const
 
void setAppId (const QString &appId)
 
void setApplicationName (const QString &applicationName)
 
void setAutoConfigureTalkersOn (bool autoConfigureTalkersOn)
 
void setDefaultPriority (KSpeech::JobPriority defaultPriority)
 
void setDefaultTalker (const QString &defaultTalker)
 
void setFilteringOn (bool filteringOn)
 
void setHtmlFilterXsltFile (const QString &filename)
 
void setIsApplicationPaused (bool isApplicationPaused)
 
void setIsSystemManager (bool isSystemManager)
 
void setSentenceDelimiter (const QString &sentenceDelimiter)
 
void setSsmlFilterXsltFile (const QString &filename)
 
void setUnregistered (bool unregistered)
 
QString ssmlFilterXsltFile () const
 
bool unregistered () const
 

Detailed Description

Definition at line 38 of file appdata.h.

Constructor & Destructor Documentation

AppData::AppData ( const QString &  appId)
explicit

Constructs a new AppData object for the given DBUS AppId.

Parameters
appIdDBUS sender id.

Definition at line 66 of file appdata.cpp.

AppData::~AppData ( )

Destructor.

Definition at line 67 of file appdata.cpp.

Member Function Documentation

QString AppData::appId ( ) const

Returns the appId for the application.

Definition at line 69 of file appdata.cpp.

QString AppData::applicationName ( ) const

Returns the friendly display name for the application.

These generally are not translated.

Definition at line 71 of file appdata.cpp.

bool AppData::autoConfigureTalkersOn ( ) const

Returns if KTTSD should attempt to automatically configure talkers to meet requested talker attributes.

Definition at line 87 of file appdata.cpp.

KSpeech::JobPriority AppData::defaultPriority ( ) const

Returns the default priority (job type) for the application.

Definition at line 75 of file appdata.cpp.

QString AppData::defaultTalker ( ) const

Returns the default talker code for the application.

Defaults to "", i.e., use the default talker configured in the system.

Definition at line 73 of file appdata.cpp.

bool AppData::filteringOn ( ) const

Returns the applications's current filtering enabled flag.

Definition at line 79 of file appdata.cpp.

QString AppData::htmlFilterXsltFile ( ) const

Returns the full path name of the XSLT file that performs HTML filtering on jobs for the application.

Definition at line 83 of file appdata.cpp.

bool AppData::isApplicationPaused ( ) const

Returns whether the jobs of the application are currently paused.

Definition at line 81 of file appdata.cpp.

bool AppData::isSystemManager ( ) const

Returns whether this application is a KTTS System Manager.

When an application is a System Manager, commands affect all jobs. For example, a pause() command will pause all jobs of all applications. Defaults to False.

Definition at line 89 of file appdata.cpp.

TJobListPtr AppData::jobList ( ) const

List of jobs for this app.

Caller may add or delete jobs, but must not delete the list.

Definition at line 98 of file appdata.cpp.

int AppData::lastJobNum ( ) const

Return the JobNum of the last job queued by the application.

0 if none.

Definition at line 91 of file appdata.cpp.

QString AppData::sentenceDelimiter ( ) const

Returns the GREP pattern that will be used as the sentence delimiter.

The default delimiter is

   ([\\.\\?\\!\\:\\;])\\s
See also
setSentenceDelimiter

Definition at line 77 of file appdata.cpp.

void AppData::setAppId ( const QString &  appId)

Sets the appId for the application.

Definition at line 70 of file appdata.cpp.

void AppData::setApplicationName ( const QString &  applicationName)

Sets the friendly display name for the application.

Parameters
applicationNameFriendly application name.

If not set, the AppId is used as the applicationName.

Definition at line 72 of file appdata.cpp.

void AppData::setAutoConfigureTalkersOn ( bool  autoConfigureTalkersOn)

Sets whether KTTSD should attempt to automatically configure talkers to meet requested talker attributes.

Parameters
autoConfigureTalkersOnTrue if autoconfigure should be on.

Definition at line 88 of file appdata.cpp.

void AppData::setDefaultPriority ( KSpeech::JobPriority  defaultPriority)

Set the default priority (job type) for the application.

Parameters
defaultPriorityJob Priority.

Definition at line 76 of file appdata.cpp.

void AppData::setDefaultTalker ( const QString &  defaultTalker)

Sets the default talker code for the application.

Parameters
defaultTalkerTalker code.

Definition at line 74 of file appdata.cpp.

void AppData::setFilteringOn ( bool  filteringOn)

Sets the applications's current filtering enabled flag.

Parameters
filteringOnTrue or False.

Definition at line 80 of file appdata.cpp.

void AppData::setHtmlFilterXsltFile ( const QString &  filename)

Sets the full path name of the XSLT file that performs HTML filtering on jobs for the application.

Parameters
filenameName of the XSLT file. Full path name.

Definition at line 84 of file appdata.cpp.

void AppData::setIsApplicationPaused ( bool  isApplicationPaused)

Sets whether the jobs of the application are currently paused.

Parameters
isApplicationPausedTrue of False.

Definition at line 82 of file appdata.cpp.

void AppData::setIsSystemManager ( bool  isSystemManager)

Sets whether this application is a KTTS System Manager.

Parameters
isSystemManagerTrue or False.

Definition at line 90 of file appdata.cpp.

void AppData::setSentenceDelimiter ( const QString &  sentenceDelimiter)

Sets the GREP pattern that will be used as the sentence delimiter.

Parameters
sentenceDelimiterA valid GREP pattern.

Note that backward slashes must be escaped.

See also
sentenceDelimiter, sentenceparsing

Definition at line 78 of file appdata.cpp.

void AppData::setSsmlFilterXsltFile ( const QString &  filename)

Sets the full path name of the XSLT file that performs SSML filtering on jobs for the application.

Parameters
filenameName of the XSLT file. Full path name.

Definition at line 86 of file appdata.cpp.

void AppData::setUnregistered ( bool  unregistered)

Definition at line 100 of file appdata.cpp.

QString AppData::ssmlFilterXsltFile ( ) const

Returns the full path name of the XSLT file that performs SSML filtering on jobs for the application.

Definition at line 85 of file appdata.cpp.

bool AppData::unregistered ( ) const

True when the app has exited.

Definition at line 99 of file appdata.cpp.


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