kexiactionproxy.h

/* This file is part of the KDE project
   Copyright (C) 2003-2004 Jaroslaw Staniek <js@iidea.pl>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   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.
*/
 
#ifndef KEXIACTIONPROXY_H
#define KEXIACTIONPROXY_H
 
#include <tqguardedptr.h>
#include <tqasciidict.h>
#include <tqobject.h>
#include <tqpair.h>
#include <tqptrlist.h>
 
#include <tdeaction.h>
 
#include "kexiproject.h"
#include "kexisharedactionhost.h"
 
class TQSignal;
class TDEAction;
class KXMLGUIClient;
class TDEAction_setEnabled_Helper;
class KexiActionProxy;


//TODO add method for setAvailable()
class KEXICORE_EXPORT KexiSharedActionConnector
{
    public:
        /* Connects shared actions offered by \a proxy to \a obj. */
        KexiSharedActionConnector(KexiActionProxy* proxy, TQObject *obj);
        ~KexiSharedActionConnector();
 
    protected:
        void plugSharedAction(const char *action_name, const char *slot);
 
        void plugSharedActionToExternalGUI(const char *action_name, KXMLGUIClient *client);
 
        void plugSharedActionsToExternalGUI(
            const TQValueList<TQCString>& action_names, KXMLGUIClient *client);
 
        KexiActionProxy* m_proxy;
        TQObject *m_object;
};


 
class KEXICORE_EXPORT KexiActionProxy
{
    public:
        KexiActionProxy(TQObject *receiver , KexiSharedActionHost *host = 0 );
        virtual ~KexiActionProxy();

        bool activateSharedAction(const char *action_name, bool alsoCheckInChildren = true);

        void setSharedActionHost(KexiSharedActionHost& host) { m_host = &host; }

        bool isAvailable(const char* action_name, bool alsoCheckInChildren = true) const;

        bool isSupported(const char* action_name) const;
 
    protected:
        void plugSharedAction(const char *action_name, TQObject* receiver, const char *slot);
 
        void unplugSharedAction(const char *action_name);

        inline void plugSharedAction(const char *action_name, const char *slot) {
            plugSharedAction(action_name, m_receiver, slot);
        }

        int plugSharedAction(const char *action_name, TQWidget* w);
 
        void plugSharedActionToExternalGUI(const char *action_name, KXMLGUIClient *client);
 
        void plugSharedActionsToExternalGUI(
            const TQValueList<TQCString>& action_names, KXMLGUIClient *client);

        void unplugSharedAction(const char *action_name, TQWidget* w);

        TDEAction* plugSharedAction(const char *action_name, const TQString& alternativeText, TQWidget* w);

        virtual TDEAction* sharedAction(const char* action_name);
 
        inline TQObject *receiver() const { return m_receiver; }
 
        virtual void setAvailable(const char* action_name, bool set);

        void addActionProxyChild( KexiActionProxy* child );
 
        void takeActionProxyChild( KexiActionProxy* child );
 
        KexiSharedActionHost *m_host;
        TQGuardedPtr<TQObject> m_receiver;
        TQAsciiDict< TQPair<TQSignal*,bool> > m_signals;
 
        TQPtrList<KexiActionProxy> m_sharedActionChildren;
 
        TQPtrList<TDEAction> m_alternativeActions;
 
        KexiActionProxy* m_actionProxyParent;
 
        TQObject m_signal_parent; 

        TDEAction_setEnabled_Helper *m_TDEAction_setEnabled_helper;
 
    public:
        void setActionProxyParent_internal( KexiActionProxy* parent );

        KexiActionProxy *m_focusedChild;
 
    friend class KexiSharedActionHost;
    friend class TDEAction_setEnabled_Helper;
    friend class KexiSharedActionConnector;
};
 
#endif