KoSpeaker.h

Go to the documentation of this file.

 
#ifndef KOSPEAKER_H
#define KOSPEAKER_H
 
// TQt includes.
#include <tqobject.h>
#include <tqstring.h>
 
// KDE includes.
#include <ksharedptr.h>
 
// KOffice includes.
#include <koffice_export.h>
 
class TQWidget;
class TQPoint;
class TDEConfig;
class KoSpeakerPrivate;
 
#define kospeaker KoSpeaker::koSpeaker()

class KOFFICECORE_EXPORT KoSpeaker : public TQObject, public TDEShared
{
   TQ_OBJECT
  
public:
    KoSpeaker();
    ~KoSpeaker();

    enum SpeakFlags {
        SpeakFocusWidget =      0x0001  ,
        SpeakPointerWidget =    0x0002  ,
        SpeakWhatsThis =        0x0004  ,
        SpeakTooltip =          0x0008  ,
        SpeakAccelerator =      0x0010  ,
        SpeakDisabled =         0x0020  
    };

    bool isEnabled() const;

    void readConfig(TDEConfig* config);

    bool maybeSayWidget(TQWidget* w, const TQPoint& pos = TQPoint());

    bool sayWidget(const TQString& msg);

    void cancelSpeakWidget();

    void queueSpeech(const TQString& msg, const TQString& langCode = TQString(), bool first = true);

    void startSpeech();

    static bool isKttsdInstalled();

    static KoSpeaker* koSpeaker() { return KSpkr; }
 
signals:
    void customSpeakNewWidget(TQWidget* w, const TQPoint& p, uint flags);

    void customSpeakWidget(TQWidget* w, const TQPoint& p, uint flags);
 
protected:
    static KoSpeaker* KSpkr;
 
private slots:
    void probe();
 
private:
    // int menuBarItemAt(TQMenuBar* m, const TQPoint& p);
 
    // Start the KTTSD daemon if not already running.
    bool startKttsd();
    // Return the KTTSD daemon version string.
    TQString getKttsdVersion();
 
    // These methods correspond to dcop interface in tdelibs/interfaces/kspeech/kspeech.h.
    // They use manual marshalling, instead of using kspeech_stub, because KOffice
    // supports KDE 3.3 and above and kspeech.h didn't appear until 3.4.
    void sayScreenReaderOutput(const TQString &msg, const TQString &talker);
    uint setText(const TQString &text, const TQString &talker);
    int appendText(const TQString &text, uint jobNum=0);
    void startText(uint jobNum=0);
    void removeText(uint jobNum=0);
 
    KoSpeakerPrivate* d;
};
 
#endif      // H_KOSPEAKER