Source: browserinterface.h

# Source: browserinterface.h |
Annotated List
Files
Globals
Hierarchy
Index

    #ifndef __browserinterface_h__
    #define __browserinterface_h__

    #include
    #include

    namespace KParts
    {

    /**
     * The purpose of this interface is to allow a direct communication between
     * a KPart and the hosting browser shell (for example Konqueror) . A
     * shell implementing this interface can propagate it to embedded kpart
     * components by using the setBrowserInterface call of the part's
     * KParts::BrowserExtension object.
     *
     * This interface looks not very rich, but the main functionality is
     * implemented using the @ref callMethod method for part->shell
     * communication and using Qt properties for allowing a part to
     * to explicitly query information from the shell.
     *
     * Konqueror in particular, as 'reference' implementation, provides
     * the following functionality through this interface:
     *
     * Qt properties:
     *   Q_PROPERTY( uint historyLength READ historyLength );
     *
     * Callable methods:
     *       void goHistory( int );
     *
     */
    class BrowserInterface : public QObject
    {
        Q_OBJECT
    public:
        BrowserInterface( QObject *parent, const char *name = 0 );
        virtual ~BrowserInterface();

        /**
         * Perform a dynamic invocation of a method in the BrowserInterface
         * implementation. Methods are to be implemented as simple Qt slots.
         */
        void callMethod( const char *name, const QVariant &argument );
    };

    }

    #endif

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:37:24 2003, using kdoc 2.0a54.