tdeactionclasses.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>
              (C) 2003 Andras Mantia <amantia@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 __tdeactionclasses_h__
#define __tdeactionclasses_h__
 
#include <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 TDEToggleAction : public TDEAction
{
    TQ_OBJECT
    
    TQ_PROPERTY( bool checked READ isChecked WRITE setChecked )
    TQ_PROPERTY( TQString exclusiveGroup READ exclusiveGroup WRITE setExclusiveGroup )
public:
 
    TDEToggleAction( const TQString& text, const TDEShortcut& cut = TDEShortcut(), TQObject* parent = 0, const char* name = 0 );
 
    TDEToggleAction( const TQString& text, const TDEShortcut& cut,
                   const TQObject* receiver, const char* slot, TQObject* parent, const char* name = 0 );
 
    TDEToggleAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut = TDEShortcut(),
             TQObject* parent = 0, const char* name = 0 );
 
    TDEToggleAction( const TQString& text, const TQString& pix, const TDEShortcut& cut = TDEShortcut(),
                   TQObject* parent = 0, const char* name = 0 );
 
    TDEToggleAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut,
                   const TQObject* receiver, const char* slot, TQObject* parent, const char* name = 0 );
 
    TDEToggleAction( const TQString& text, const TQString& pix, const TDEShortcut& cut,
                   const TQObject* receiver, const char* slot,
                   TQObject* parent, const char* name = 0 );
 
    TDEToggleAction( TQObject* parent = 0, const char* name = 0 );
 
    virtual ~TDEToggleAction();
 
    virtual int plug( TQWidget* widget, int index = -1 );
 
    bool isChecked() const;
 
    TQString exclusiveGroup() const;
 
    virtual void setExclusiveGroup( const TQString& name );
 
    void setCheckedState( const KGuiItem& checkedItem );
 
    virtual TQString toolTip() const;
 
public slots:
    virtual void setChecked( bool );
 
protected slots:
    virtual void slotActivated();
 
protected:
    virtual void updateChecked( int id );
 
signals:
    void toggled( bool );
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDEToggleActionPrivate;
    TDEToggleActionPrivate *d;
};
 
class TDEUI_EXPORT TDERadioAction : public TDEToggleAction
{
  TQ_OBJECT
  
public:
    TDERadioAction( const TQString& text, const TDEShortcut& cut = TDEShortcut(), TQObject* parent = 0, const char* name = 0 );
 
    TDERadioAction( const TQString& text, const TDEShortcut& cut,
                  const TQObject* receiver, const char* slot, TQObject* parent, const char* name = 0 );
 
    TDERadioAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut = TDEShortcut(),
                  TQObject* parent = 0, const char* name = 0 );
 
    TDERadioAction( const TQString& text, const TQString& pix, const TDEShortcut& cut = TDEShortcut(),
                  TQObject* parent = 0, const char* name = 0 );
 
    TDERadioAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut,
                  const TQObject* receiver, const char* slot, TQObject* parent, const char* name = 0 );
 
    TDERadioAction( const TQString& text, const TQString& pix, const TDEShortcut& cut,
                  const TQObject* receiver, const char* slot,
                  TQObject* parent, const char* name = 0 );
 
    TDERadioAction( TQObject* parent = 0, const char* name = 0 );
 
protected:
    virtual void slotActivated();
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDERadioActionPrivate;
    TDERadioActionPrivate *d;
};
 
class TDEUI_EXPORT TDESelectAction : public TDEAction
{
    TQ_OBJECT
    
    TQ_PROPERTY( int currentItem READ currentItem WRITE setCurrentItem )
    TQ_PROPERTY( TQStringList items READ items WRITE setItems )
    TQ_PROPERTY( bool editable READ isEditable WRITE setEditable )
    TQ_PROPERTY( int comboWidth READ comboWidth WRITE setComboWidth )
    TQ_PROPERTY( TQString currentText READ currentText )
    TQ_PROPERTY( bool menuAccelsEnabled READ menuAccelsEnabled WRITE setMenuAccelsEnabled )
public:
 
    TDESelectAction( const TQString& text, const TDEShortcut& cut = TDEShortcut(), TQObject* parent = 0, const char* name = 0 );
 
    TDESelectAction( const TQString& text, const TDEShortcut& cut,
                   const TQObject* receiver, const char* slot, TQObject* parent, const char* name = 0 );
 
    TDESelectAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut = TDEShortcut(),
             TQObject* parent = 0, const char* name = 0 );
 
    TDESelectAction( const TQString& text, const TQString& pix, const TDEShortcut& cut = TDEShortcut(),
                   TQObject* parent = 0, const char* name = 0 );
 
    TDESelectAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut,
                   const TQObject* receiver, const char* slot, TQObject* parent, const char* name = 0 );
 
    TDESelectAction( const TQString& text, const TQString& pix, const TDEShortcut& cut,
                   const TQObject* receiver, const char* slot,
                   TQObject* parent, const char* name = 0 );
 
    TDESelectAction( TQObject* parent = 0, const char* name = 0 );
 
    virtual ~TDESelectAction();
 
    virtual int plug( TQWidget* widget, int index = -1 );
 
    virtual bool isEditable() const;
 
    virtual TQStringList items() const;
 
    virtual void changeItem( int index, const TQString& text );
 
    virtual TQString currentText() const;
 
    virtual int currentItem() const;
 
    virtual int comboWidth() const;
 
    void setMaxComboViewCount( int n );
 
    TQPopupMenu* popupMenu() const;
 
    void setRemoveAmpersandsInCombo( bool b ) TDE_DEPRECATED;
    bool removeAmpersandsInCombo() const;
 
    void setMenuAccelsEnabled( bool b );
    bool menuAccelsEnabled() const;
 
    virtual bool isShortcutConfigurable() const { return false; }
 
public slots:
    virtual void setCurrentItem( int index );
 
    virtual void setItems( const TQStringList &lst );
 
    virtual void clear();
 
    virtual void setEditable( bool );
 
    virtual void setComboWidth( int width );
 
protected:
    virtual void changeItem( int id, int index, const TQString& text );
 
    TQStringList comboItems() const;
 
protected slots:
    virtual void slotActivated( int id );
    virtual void slotActivated( const TQString &text );
    virtual void slotActivated();
 
signals:
    void activated( int index );
    void activated( const TQString& text );
 
protected:
    virtual void updateCurrentItem( int id );
 
    virtual void updateComboWidth( int id );
 
    virtual void updateItems( int id );
 
    virtual void updateClear( int id );
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    void setupMenu() const;
    class TDESelectActionPrivate;
    TDESelectActionPrivate *d;
 
};
 
 
class TDEUI_EXPORT_DEPRECATED TDEListAction : public TDESelectAction
{
    TQ_OBJECT
    
public:
    TDEListAction( const TQString& text, const TDEShortcut& cut = TDEShortcut(), TQObject* parent = 0,
                  const char* name = 0 );
 
    TDEListAction( const TQString& text, const TDEShortcut& cut, const TQObject* receiver,
                  const char* slot, TQObject* parent, const char* name = 0 );
 
    TDEListAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut = TDEShortcut(),
                      TQObject* parent = 0, const char* name = 0 );
 
    TDEListAction( const TQString& text, const TQString& pix, const TDEShortcut& cut = TDEShortcut(),
                      TQObject* parent = 0, const char* name = 0 );
 
    TDEListAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut,
                          const TQObject* receiver, const char* slot, TQObject* parent,
                  const char* name = 0 );
 
    TDEListAction( const TQString& text, const TQString& pix, const TDEShortcut& cut,
                 const TQObject* receiver, const char* slot, TQObject* parent,
                 const char* name = 0 );
 
    TDEListAction( TQObject* parent = 0, const char* name = 0 );
 
    virtual ~TDEListAction();
 
 
    virtual TQString currentText() const;
    virtual int currentItem() const;
 
 
public slots:
    virtual void setCurrentItem( int index );
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDEListActionPrivate;
    TDEListActionPrivate *d;
};
 
class TDEUI_EXPORT TDERecentFilesAction : public TDEListAction  // TODO public TDESelectAction
{
  TQ_OBJECT
  
  TQ_PROPERTY( uint maxItems READ maxItems WRITE setMaxItems )
public:
  TDERecentFilesAction( const TQString& text, const TDEShortcut& cut,
                      TQObject* parent, const char* name = 0,
                      uint maxItems = 10 );
 
  TDERecentFilesAction( const TQString& text, const TDEShortcut& cut,
                      const TQObject* receiver, const char* slot,
                      TQObject* parent, const char* name = 0,
                      uint maxItems = 10 );
 
  TDERecentFilesAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut,
                      TQObject* parent, const char* name = 0,
                      uint maxItems = 10 );
 
  TDERecentFilesAction( const TQString& text, const TQString& pix, const TDEShortcut& cut,
                      TQObject* parent, const char* name = 0,
                      uint maxItems = 10 );
 
  TDERecentFilesAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut,
                      const TQObject* receiver, const char* slot,
                      TQObject* parent, const char* name = 0,
                      uint maxItems = 10 );
 
  TDERecentFilesAction( const TQString& text, const TQString& pix, const TDEShortcut& cut,
                      const TQObject* receiver, const char* slot,
                      TQObject* parent, const char* name = 0,
                      uint maxItems = 10 );
 
  TDERecentFilesAction( TQObject* parent = 0, const char* name = 0,
                      uint maxItems = 10 );
 
  virtual ~TDERecentFilesAction();
 
  virtual int plug( TQWidget *widget, int index = -1 );
 
  uint maxItems() const;
 
//KDE4: remove completeItems() and rename items() to urls(), to get the list of URLs added to
//      the action.
  virtual TQStringList items() const;
 
  TQStringList completeItems() const;
 
public slots:
  void setMaxItems( uint maxItems );
 
  void loadEntries( TDEConfig* config, TQString groupname=TQString::null );
 
  void saveEntries( TDEConfig* config, TQString groupname=TQString::null );
 
  void addURL( const KURL& url );
 
  void addURL( const KURL& url, const TQString& name ); //KDE4: Combine the above two methods
 
  void removeURL( const KURL& url );
 
  void clearURLList();
 
signals:
 
  void urlSelected( const KURL& url );
 
protected slots:
  void itemSelected( const TQString& string );
  void menuAboutToShow();
  void menuItemActivated( int id );
  void slotClicked();
  virtual void slotActivated(int);
  virtual void slotActivated(const TQString& );
  virtual void slotActivated();
 
protected:
  virtual void virtual_hook( int id, void* data );
 
private:
  void init();
 
  class TDERecentFilesActionPrivate;
  TDERecentFilesActionPrivate *d;
};
 
class TDEUI_EXPORT TDEFontAction : public TDESelectAction
{
    TQ_OBJECT
    
    TQ_PROPERTY( TQString font READ font WRITE setFont )
public:
    TDEFontAction( const TQString& text, const TDEShortcut& cut = TDEShortcut(), TQObject* parent = 0,
                 const char* name = 0 );
    TDEFontAction( const TQString& text, const TDEShortcut& cut,
                 const TQObject* receiver, const char* slot, TQObject* parent,
                 const char* name = 0 );
    TDEFontAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut = TDEShortcut(),
                 TQObject* parent = 0, const char* name = 0 );
    TDEFontAction( const TQString& text, const TQString& pix, const TDEShortcut& cut = TDEShortcut(),
                 TQObject* parent = 0, const char* name = 0 );
    TDEFontAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut,
                 const TQObject* receiver, const char* slot, TQObject* parent,
                 const char* name = 0 );
    TDEFontAction( const TQString& text, const TQString& pix, const TDEShortcut& cut,
                 const TQObject* receiver, const char* slot, TQObject* parent,
                 const char* name = 0 );
 
// The ctors with fontListCriteria were added after 3.3-beta1.
// This define is used in koffice. Remove when koffice has a dependency on tdelibs-3.3 or more.
#define KFONTACTION_HAS_CRITERIA_ARG
    TDEFontAction( uint fontListCriteria, const TQString& text,
                 const TDEShortcut& cut = TDEShortcut(), TQObject* parent = 0,
                 const char* name = 0 );
    TDEFontAction( uint fontListCriteria, const TQString& text, const TQString& pix,
                 const TDEShortcut& cut = TDEShortcut(),
                 TQObject* parent = 0, const char* name = 0 );
 
    TDEFontAction( TQObject* parent = 0, const char* name = 0 );
    ~TDEFontAction();
 
    TQString font() const {
        return currentText();
    }
 
    int plug( TQWidget*widget, int index = -1 );
 
public slots:
    void setFont( const TQString &family );
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDEFontActionPrivate;
    TDEFontActionPrivate *d;
};
 
class TDEUI_EXPORT TDEFontSizeAction : public TDESelectAction
{
    TQ_OBJECT
    
    TQ_PROPERTY( int fontSize READ fontSize WRITE setFontSize )
public:
    TDEFontSizeAction( const TQString& text, const TDEShortcut& cut = TDEShortcut(), TQObject* parent = 0,
                     const char* name = 0 );
    TDEFontSizeAction( const TQString& text, const TDEShortcut& cut, const TQObject* receiver,
                     const char* slot, TQObject* parent, const char* name = 0 );
    TDEFontSizeAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut = TDEShortcut(),
                     TQObject* parent = 0, const char* name = 0 );
    TDEFontSizeAction( const TQString& text, const TQString& pix, const TDEShortcut& cut = TDEShortcut(),
                     TQObject* parent = 0, const char* name = 0 );
    TDEFontSizeAction( const TQString& text, const TQIconSet& pix, const TDEShortcut& cut,
                     const TQObject* receiver, const char* slot,
                     TQObject* parent, const char* name = 0 );
    TDEFontSizeAction( const TQString& text, const TQString& pix, const TDEShortcut& cut,
                     const TQObject* receiver, const char* slot,
                     TQObject* parent, const char* name = 0 );
    TDEFontSizeAction( TQObject* parent = 0, const char* name = 0 );
 
    virtual ~TDEFontSizeAction();
 
    virtual int fontSize() const;
 
public slots:
    virtual void setFontSize( int size );
 
protected slots:
    virtual void slotActivated( int );
    virtual void slotActivated( const TQString& );
    virtual void slotActivated() { TDEAction::slotActivated(); }
 
signals:
    void fontSizeChanged( int );
 
private:
    void init();
 
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDEFontSizeActionPrivate;
    TDEFontSizeActionPrivate *d;
};
 
 
class TDEUI_EXPORT TDEActionMenu : public TDEAction
{
  TQ_OBJECT
  
  TQ_PROPERTY( bool delayed READ delayed WRITE setDelayed )
  TQ_PROPERTY( bool stickyMenu READ stickyMenu WRITE setStickyMenu )
 
public:
    TDEActionMenu( const TQString& text, TQObject* parent = 0,
                 const char* name = 0 );
    TDEActionMenu( const TQString& text, const TQIconSet& icon,
                 TQObject* parent = 0, const char* name = 0 );
    TDEActionMenu( const TQString& text, const TQString& icon,
                 TQObject* parent = 0, const char* name = 0 );
    TDEActionMenu( TQObject* parent = 0, const char* name = 0 );
    virtual ~TDEActionMenu();
 
    virtual void insert( TDEAction*, int index = -1 );
    virtual void remove( TDEAction* );
 
    TDEPopupMenu* popupMenu() const;
    void popup( const TQPoint& global );
 
    bool delayed() const;
    void setDelayed(bool _delayed);
 
    bool stickyMenu() const;
    void setStickyMenu(bool sticky);
 
    virtual int plug( TQWidget* widget, int index = -1 );
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDEActionMenuPrivate;
    TDEActionMenuPrivate *d;
};
 
class TDEUI_EXPORT TDEToolBarPopupAction : public TDEAction
{
  TQ_OBJECT
  
  TQ_PROPERTY( bool delayed READ delayed WRITE setDelayed )
  TQ_PROPERTY( bool stickyMenu READ stickyMenu WRITE setStickyMenu )
 
public:
    //Not all constructors - because we need an icon, since this action only makes
    // sense when being plugged at least in a toolbar.
    TDEToolBarPopupAction( const TQString& text, const TQString& icon, const TDEShortcut& cut = TDEShortcut(),
                         TQObject* parent = 0, const char* name = 0 );
 
    TDEToolBarPopupAction( const TQString& text, const TQString& icon, const TDEShortcut& cut,
                         const TQObject* receiver, const char* slot,
                         TQObject* parent = 0, const char* name = 0 );
 
    TDEToolBarPopupAction( const KGuiItem& item, const TDEShortcut& cut,
                         const TQObject* receiver, const char* slot,
                         TDEActionCollection* parent, const char* name );
 
    virtual ~TDEToolBarPopupAction();
 
    virtual int plug( TQWidget *widget, int index = -1 );
 
    TDEPopupMenu *popupMenu() const;
 
    bool delayed() const;
    void setDelayed(bool delayed);
    bool stickyMenu() const;
    void setStickyMenu(bool sticky);
 
private:
    TDEPopupMenu *m_popup;
    bool m_delayed:1;
    bool m_stickyMenu:1;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDEToolBarPopupActionPrivate;
    TDEToolBarPopupActionPrivate *d;
};
 
class TDEUI_EXPORT TDEToggleToolBarAction : public TDEToggleAction
{
    TQ_OBJECT
    
public:
    TDEToggleToolBarAction( const char* toolBarName, const TQString& text,
                          TDEActionCollection* parent, const char* name );
    TDEToggleToolBarAction( TDEToolBar *toolBar, const TQString &text,
                          TDEActionCollection *parent, const char *name );
    virtual ~TDEToggleToolBarAction();
 
    virtual int plug( TQWidget * widget, int index = -1 );
 
    TDEToolBar *toolBar() { return m_toolBar; }
 
public slots:
    virtual void setChecked( bool );
 
private:
    TQCString               m_toolBarName;
    TQGuardedPtr<TDEToolBar>  m_toolBar;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDEToggleToolBarActionPrivate;
    TDEToggleToolBarActionPrivate *d;
};
 
class TDEUI_EXPORT TDEToggleFullScreenAction : public TDEToggleAction
{
    TQ_OBJECT
    
public:
    TDEToggleFullScreenAction( const TDEShortcut &cut,
                             const TQObject* receiver, const char* slot,
                             TQObject* parent, TQWidget* window,
                             const char* name );
    virtual ~TDEToggleFullScreenAction();
 
    void setWindow( TQWidget* window );
public slots:
    virtual void setChecked( bool );
protected:
    virtual bool eventFilter( TQObject* o, TQEvent* e );
private:
    TQWidget* window;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDEToggleFullScreenActionPrivate;
    TDEToggleFullScreenActionPrivate *d;
};
 
 
class TDEUI_EXPORT KWidgetAction : public TDEAction
{
    TQ_OBJECT
    
public:
    KWidgetAction( TQWidget* widget, const TQString& text,
                   const TDEShortcut& cut,
                   const TQObject* receiver, const char* slot,
                   TDEActionCollection* parent, const char* name );
    virtual ~KWidgetAction();
 
    TQWidget* widget() { return m_widget; }
 
    void setAutoSized( bool );
 
    virtual int plug( TQWidget* widget, int index = -1 );
    virtual void unplug( TQWidget *w );
protected slots:
    void slotToolbarDestroyed();
private:
    TQGuardedPtr<TQWidget> m_widget;
    bool                 m_autoSized;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class KWidgetActionPrivate;
    KWidgetActionPrivate *d;
};
 
class TDEUI_EXPORT TDEActionSeparator : public TDEAction
{
    TQ_OBJECT
    
public:
    TDEActionSeparator( TQObject* parent = 0, const char* name = 0 );
    virtual ~TDEActionSeparator();
 
    virtual int plug( TQWidget *widget, int index = -1 );
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class TDEActionSeparatorPrivate;
    TDEActionSeparatorPrivate *d;
};
 
class TDEUI_EXPORT TDEPasteTextAction: public TDEAction
{
    TQ_OBJECT
    
public:
    TDEPasteTextAction( const TQString& text, const TQString& icon, const TDEShortcut& cut,
                  const TQObject* receiver, const char* slot,
                  TQObject* parent = 0, const char* name = 0 );
 
    virtual ~TDEPasteTextAction();
 
    void setMixedMode(bool mode);
 
    virtual int plug( TQWidget *widget, int index = -1 );
 
protected slots:
    void menuAboutToShow();
    void menuItemActivated( int id);
    virtual void slotActivated();
 
protected:
    virtual void virtual_hook( int id, void* data );
 
private:
    TDEPopupMenu *m_popup;
    bool m_mixedMode;
    class TDEPasteTextActionPrivate;
    TDEPasteTextActionPrivate *d;
};
 
#endif