tdebase/khotkeys/shared/triggers.h

/****************************************************************************

 KHotKeys
 
 Copyright (C) 1999-2001 Lubos Lunak <l.lunak@kde.org>

 Distributed under the terms of the GNU General Public License version 2.
 
****************************************************************************/

#ifndef _TRIGGERS_H_
#define _TRIGGERS_H_

#include <tqptrlist.h>
#include <tqtimer.h>
#include <tqmap.h>
#include <kdemacros.h>

#include "khotkeysglobal.h"
#include "voicesignature.h"

#include "input.h"

class TDEConfig;

namespace KHotKeys
{

class Windowdef_list;
class Action_data;

class KDE_EXPORT Trigger
    {
    public:
        Trigger( Action_data* data_P );
        Trigger( TDEConfig& cfg_P, Action_data* data_P );
        virtual ~Trigger();
        virtual void cfg_write( TDEConfig& cfg_P ) const = 0;
        virtual Trigger* copy( Action_data* data_P ) const = 0;
        virtual const TQString description() const = 0;
        static Trigger* create_cfg_read( TDEConfig& cfg_P, Action_data* data_P );
        virtual void activate( bool activate_P ) = 0;
    protected:
        Action_data* const data;
    KHOTKEYS_DISABLE_COPY( Trigger );
    };

class KDE_EXPORT Trigger_list
    : public TQPtrList< Trigger >
    {
    public:
        Trigger_list( const TQString& comment_P ); // CHECKME nebo i data ?
        Trigger_list( TDEConfig& cfg_P, Action_data* data_P );
        void activate( bool activate_P );
        void cfg_write( TDEConfig& cfg_P ) const;
        typedef TQPtrListIterator< Trigger > Iterator;
        const TQString& comment() const;
        Trigger_list* copy( Action_data* data_P ) const;
    private:
        TQString _comment;
    KHOTKEYS_DISABLE_COPY( Trigger_list );
    };
    
class KDE_EXPORT Shortcut_trigger
    : public Trigger, public Kbd_receiver
    {
    typedef Trigger base;
    public:
        Shortcut_trigger( Action_data* data_P, const TDEShortcut& shortcut_P );
        Shortcut_trigger( TDEConfig& cfg_P, Action_data* data_P );
        virtual ~Shortcut_trigger();
        virtual void cfg_write( TDEConfig& cfg_P ) const;
        virtual Shortcut_trigger* copy( Action_data* data_P ) const;
        virtual const TQString description() const;
        const TDEShortcut& shortcut() const;
        virtual bool handle_key( const TDEShortcut& shortcut_P );
        virtual void activate( bool activate_P );
    private:
        TDEShortcut _shortcut;
    };

class KDE_EXPORT Window_trigger
    : public TQObject, public Trigger        
    {
    TQ_OBJECT
    typedef Trigger base;
    public:
        enum window_action_t
            {
            WINDOW_APPEARS         = ( 1 << 0 ),
            WINDOW_DISAPPEARS      = ( 1 << 1 ),
            WINDOW_ACTIVATES       = ( 1 << 2 ),
            WINDOW_DEACTIVATES     = ( 1 << 3 )
            };
        Window_trigger( Action_data* data_P, Windowdef_list* windows_P, int window_actions_P );
        Window_trigger( TDEConfig& cfg_P, Action_data* data_P );
        virtual ~Window_trigger();
        virtual void cfg_write( TDEConfig& cfg_P ) const;
#ifndef COVARIANT_RETURN_BROKEN    // stupid gcc, it doesn't even warn it can't do this
        virtual Window_trigger* copy( Action_data* data_P ) const;
#else
        virtual Trigger* copy( Action_data* data_P ) const;
#endif
        virtual const TQString description() const;
        const Windowdef_list* windows() const;
        bool triggers_on( window_action_t w_action_P ) const;
        virtual void activate( bool activate_P );
    protected: // CHECKME neco private ?
        Windowdef_list* _windows;
        int window_actions;
        void init();
        typedef TQMap< WId, bool > Windows_map;
        Windows_map existing_windows;
        WId last_active_window;
    protected slots:
        void window_added( WId window_P );
        void window_removed( WId window_P );
        void active_window_changed( WId window_P );
        void window_changed( WId window_P, unsigned int dirty_P );
    protected:
        bool active;
    };

class KDE_EXPORT Gesture_trigger
    : public TQObject, public Trigger
    {
    TQ_OBJECT
    typedef Trigger base;
    public:
        Gesture_trigger( Action_data* data_P, const TQString& gesture_P );
        Gesture_trigger( TDEConfig& cfg_P, Action_data* data_P );
        virtual ~Gesture_trigger();
        virtual void cfg_write( TDEConfig& cfg_P ) const;
        virtual Trigger* copy( Action_data* data_P ) const;
        virtual const TQString description() const;
        const TQString& gesturecode() const;
        virtual void activate( bool activate_P );
    protected slots:
        void handle_gesture( const TQString& gesture_P, WId window_P );
    private:
        TQString _gesturecode;
    };


class KDE_EXPORT Voice_trigger
    : public TQObject, public Trigger
    {
    TQ_OBJECT
    typedef Trigger base;
    public:
		Voice_trigger( Action_data* data_P, const TQString& Voice_P, const VoiceSignature & signature1_P, const VoiceSignature & signature2_P );
        Voice_trigger( TDEConfig& cfg_P, Action_data* data_P );
        virtual ~Voice_trigger();
        virtual void cfg_write( TDEConfig& cfg_P ) const;
        virtual Trigger* copy( Action_data* data_P ) const;
        virtual const TQString description() const;
        const TQString& voicecode() const;
        virtual void activate( bool activate_P );
		VoiceSignature voicesignature( int ech ) const;
    public slots:
        void handle_Voice(  );
    private:
        TQString _voicecode;
		VoiceSignature _voicesignature[2];
    };


//***************************************************************************
// Inline
//***************************************************************************

// Trigger

inline
Trigger::Trigger( Action_data* data_P )
    : data( data_P )
    {
    }

inline
Trigger::Trigger( TDEConfig&, Action_data* data_P )
    : data( data_P )
    {
    }
        
inline
Trigger::~Trigger()
    {
    }

// Trigger_list
    
inline
Trigger_list::Trigger_list( const TQString& comment_P )
    : TQPtrList< Trigger >(), _comment( comment_P )
    {
    setAutoDelete( true );
    }

inline
const TQString& Trigger_list::comment() const
    {
    return _comment;
    }
    
// Shortcut_trigger

inline
const TDEShortcut& Shortcut_trigger::shortcut() const
    {
    return _shortcut;
    }

// Window_trigger

inline
Window_trigger::Window_trigger( Action_data* data_P, Windowdef_list* windows_P,
     int window_actions_P )
    : Trigger( data_P ), _windows( windows_P ), window_actions( window_actions_P ),
      last_active_window( None ), active( false )
    {
    init();
    }
    
inline
const Windowdef_list* Window_trigger::windows() const
    {
    return _windows;
    }
    
inline
bool Window_trigger::triggers_on( window_action_t w_action_P ) const
    {
    return window_actions & w_action_P;
    }

// Gesture_trigger

inline
const TQString& Gesture_trigger::gesturecode() const
    {
    return _gesturecode;
    }

// Voice_trigger
inline
const TQString& Voice_trigger::voicecode() const
	{
		return _voicecode;
	}

inline
VoiceSignature Voice_trigger::voicesignature(int ech) const
	{
		return _voicesignature[ech-1];
	}

} // namespace KHotKeys
    
#endif