tdeaction.h

/* This file is part of the KDE libraries
    Copyright (C) 1999 Reginald Stadlbauer <reggie@kde.org>
              (C) 1999 Simon Hausmann <hausmann@kde.org>
              (C) 2000 Nicolas Hadacek <haadcek@kde.org>
              (C) 2000 Kurt Granroth <granroth@kde.org>
              (C) 2000 Michael Koch <koch@kde.org>
              (C) 2001 Holger Freyther <freyther@kde.org>
              (C) 2002 Ellis Whitehead <ellis@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
//$Id$
 
#ifndef __tdeaction_h__
#define __tdeaction_h__
 
#include <tqkeysequence.h>
#include <tqobject.h>
#include <tqvaluelist.h>
#include <tqguardedptr.h>
#include <kguiitem.h>
#include <tdeshortcut.h>
#include <kstdaction.h>
#include <kicontheme.h>
 
class TQMenuBar;
class TQPopupMenu;
class TQComboBox;
class TQPoint;
class TQIconSet;
class TQString;
class TDEToolBar;
 
class TDEAccel;
class TDEAccelActions;
class TDEConfig;
class TDEConfigBase;
class KURL;
class TDEInstance;
class TDEToolBar;
class TDEActionCollection;
class TDEPopupMenu;
class TDEMainWindow;

class TDEUI_EXPORT TDEAction : public TQObject
{
  friend class TDEActionCollection;
  TQ_OBJECT
  TQ_PROPERTY( int containerCount READ containerCount )
  TQ_PROPERTY( TQString plainText READ plainText )
  TQ_PROPERTY( TQString text READ text WRITE setText )
  TQ_PROPERTY( TQString shortcut READ shortcutText WRITE setShortcutText )
  TQ_PROPERTY( bool enabled READ isEnabled WRITE setEnabled )
  TQ_PROPERTY( TQString group READ group WRITE setGroup )
  TQ_PROPERTY( TQString whatsThis READ whatsThis WRITE setWhatsThis )
  TQ_PROPERTY( TQString toolTip READ toolTip WRITE setToolTip )
  TQ_PROPERTY( TQString icon READ icon WRITE setIcon )
public:
    TDEAction( const TQString& text, const TDEShortcut& cut,
             const TQObject* receiver, const char* slot,
             TDEActionCollection* parent, const char* name );

    TDEAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut,
             const TQObject* receiver, const char* slot,
             TDEActionCollection* parent, const char* name );

    TDEAction( const TQString& text, const TQString& pix, const TDEShortcut& cut,
             const TQObject* receiver, const char* slot,
             TDEActionCollection* parent, const char* name );

    TDEAction( const KGuiItem& item, const TDEShortcut& cut,
             const TQObject* receiver, const char* slot,
             TDEActionCollection* parent, const char* name );

    TDEAction( const TQString& text, const TDEShortcut& cut = TDEShortcut(), TQObject* parent = 0, const char* name = 0 );
    TDEAction( const TQString& text, const TDEShortcut& cut,
        const TQObject* receiver, const char* slot, TQObject* parent, const char* name = 0 );
    TDEAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut = TDEShortcut(),
        TQObject* parent = 0, const char* name = 0 );
    TDEAction( const TQString& text, const TQString& pix, const TDEShortcut& cut = TDEShortcut(),
        TQObject* parent = 0, const char* name = 0 );
    TDEAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut,
        const TQObject* receiver, const char* slot, TQObject* parent, const char* name = 0 );
    TDEAction( const TQString& text, const TQString& pix, const TDEShortcut& cut,
        const TQObject* receiver, const char* slot, TQObject* parent,
        const char* name = 0 );
    TDEAction( TQObject* parent = 0, const char* name = 0 );

    virtual ~TDEAction();

    virtual int plug( TQWidget *widget, int index = -1 );

    virtual void plugAccel(TDEAccel *accel, bool configurable = true) TDE_DEPRECATED;

    virtual void unplug( TQWidget *w );

    virtual void unplugAccel() TDE_DEPRECATED;

    virtual bool isPlugged() const;

    bool isPlugged( const TQWidget *container ) const;

    virtual bool isPlugged( const TQWidget *container, int id ) const;

    virtual bool isPlugged( const TQWidget *container, const TQWidget *_representative ) const;
 
    TQWidget* container( int index ) const;
    int itemId( int index ) const;
    TQWidget* representative( int index ) const;
    int containerCount() const;
    uint tdeaccelCount() const;
 
    virtual bool hasIcon() const;
#ifndef KDE_NO_COMPAT
    bool hasIconSet() const { return hasIcon(); }
#endif
    virtual TQString plainText() const;

    virtual TQString text() const;

    virtual const TDEShortcut& shortcut() const;
    virtual const TDEShortcut& shortcutDefault() const;
 
    // These two methods are for TQ_PROPERTY
    TQString shortcutText() const;
    void setShortcutText( const TQString& );

    virtual bool isEnabled() const;

    virtual bool isShortcutConfigurable() const;
 
    virtual TQString group() const;

    virtual TQString whatsThis() const;

    virtual TQString toolTip() const;

    virtual TQIconSet iconSet( TDEIcon::Group group, int size=0 ) const;
    TQIconSet iconSet() const { return iconSet( TDEIcon::Small ); }
 
    virtual TQString icon() const;
 
    TDEActionCollection *parentCollection() const;

    static int getToolButtonID();
 
 
    void unplugAll();

    enum ActivationReason { UnknownActivation, EmulatedActivation, AccelActivation, PopupMenuActivation, ToolBarActivation };
 
public slots:
    virtual void setText(const TQString &text);

    virtual bool setShortcut( const TDEShortcut& );
 
    virtual void setGroup( const TQString& );

    virtual void setWhatsThis( const TQString& text );

    virtual void setToolTip( const TQString& );

    virtual void setIconSet( const TQIconSet &iconSet );
 
    virtual void setIcon( const TQString& icon );

    virtual void setEnabled(bool enable);
    
    void setDisabled(bool disable) { return setEnabled(!disable); }

    virtual void setShortcutConfigurable( bool );

    virtual void activate();
 
protected slots:
    virtual void slotDestroyed();
    virtual void slotKeycodeChanged();
    virtual void slotActivated();
    void slotPopupActivated(); // KDE4: make virtual
    void slotButtonClicked( int, TQt::ButtonState state ); // KDE4: make virtual
 
protected:
    TDEToolBar* toolBar( int index ) const;
    TQPopupMenu* popupMenu( int index ) const;
    void removeContainer( int index );
    int findContainer( const TQWidget* widget ) const;
    int findContainer( int id ) const;
    void plugMainWindowAccel( TQWidget *w );
 
    void addContainer( TQWidget* parent, int id );
    void addContainer( TQWidget* parent, TQWidget* representative );
 
    virtual void updateShortcut( int i );
    virtual void updateShortcut( TQPopupMenu* menu, int id );
    virtual void updateGroup( int id );
    virtual void updateText(int i );
    virtual void updateEnabled(int i);
    virtual void updateIconSet(int i);
    virtual void updateIcon( int i);
    virtual void updateToolTip( int id );
    virtual void updateWhatsThis( int i );
 
    TDEActionCollection *m_parentCollection;
    TQString whatsThisWithIcon() const;
    const KGuiItem& guiItem() const;
 
signals:
    void activated();
    void activated( TDEAction::ActivationReason reason, TQt::ButtonState state );
    void enabled( bool );
 
private:
    void initPrivate( const TQString& text, const TDEShortcut& cut,
                  const TQObject* receiver, const char* slot );
    TDEAccel* tdeaccelCurrent();
    bool initShortcut( const TDEShortcut& );
    void plugShortcut();
    bool updateTDEAccelShortcut( TDEAccel* tdeaccel );
    void insertTDEAccel( TDEAccel* );
    void removeTDEAccel( TDEAccel* );
 
#ifndef KDE_NO_COMPAT
public:
    int accel() const TDE_DEPRECATED;
 
    TQString statusText() const
        { return toolTip(); }

    void setAccel( int key ) TDE_DEPRECATED;

    void setStatusText( const TQString &text )
         { setToolTip( text ); }

    int menuId( int i ) { return itemId( i ); }
#endif // !KDE_NO_COMPAT
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDEActionPrivate;
    TDEActionPrivate* const d;
};
 
#include <tdeactioncollection.h>
#include <tdeactionclasses.h>
 
#endif