Source: event.h

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

    /* This file is part of the KDE project
       Copyright (C) 1999 Simon Hausmann
                 (C) 1999 David Faure

       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., 59 Temple Place - Suite 330,
       Boston, MA 02111-1307, USA.
    */
    #ifndef __kparts_event_h__
    #define __kparts_event_h__

    #include

    class QWidget;

    namespace KParts
    {
    class Part;

    /**
     * Base class for all KParts events.
     */
    class Event : public QCustomEvent
    {
    public:
      Event( const char *eventName );

      virtual const char *eventName() const;

      static bool test( const QEvent *event );
      static bool test( const QEvent *event, const char *name );
    };

    /**
     * This event is sent to a Part when its GUI has been activated or deactivated.
     * This is related to PartActivateEvent, but the difference is that
     * GUIActivateEvent happens later (when the GUI is actually built),
     * only for parts that have GUI elements, and only if using KParts::MainWindow.
     * @see KParts::Part::guiActivateEvent()
     */
    class GUIActivateEvent : public Event
    {
    public:
      GUIActivateEvent( bool activated ) : Event( s_strGUIActivateEvent ), m_bActivated( activated ) {}

      bool activated() const { return m_bActivated; }

      static bool test( const QEvent *event ) { return Event::test( event, s_strGUIActivateEvent ); }

    private:
      static const char *s_strGUIActivateEvent;
      bool m_bActivated;
    };

    /**
     * This event is sent by the part manager when the active part changes.
     * Each time the active part changes, it will send first a PartActivateEvent
     * with activated=false, part=oldActivePart, widget=oldActiveWidget
     * and then another PartActivateEvent
     * with activated=true, part=newPart, widget=newWidget.
     * @see KParts::Part::partActivateEvent
     */
    class PartActivateEvent : public Event
    {
    public:
      PartActivateEvent( bool activated, Part *part, QWidget *widget ) : Event( s_strPartActivateEvent ), m_bActivated( activated ), m_part( part ), m_widget( widget ) {}

      bool activated() const { return m_bActivated; }

      Part *part() const { return m_part; }
      QWidget *widget() const { return m_widget; }

      static bool test( const QEvent *event ) { return Event::test( event, s_strPartActivateEvent ); }

    private:
      static const char *s_strPartActivateEvent;
      bool m_bActivated;
      Part *m_part;
      QWidget *m_widget;
    };

    /**
     * This event is sent when a part is selected or deselected.
     * @see KParts::PartManager::setSelectionPolicy
     */
    class PartSelectEvent : public Event
    {
    public:
      PartSelectEvent( bool selected, Part *part, QWidget *widget ) : Event( s_strPartSelectEvent ), m_bSelected( selected ), m_part( part ), m_widget( widget ) {}

      bool selected() const { return m_bSelected; }

      Part *part() const { return m_part; }
      QWidget *widget() const { return m_widget; }

      static bool test( const QEvent *event ) { return Event::test( event, s_strPartSelectEvent ); }

    private:
      static const char *s_strPartSelectEvent;
      bool m_bSelected;
      Part *m_part;
      QWidget *m_widget;
    };

    }

    #endif

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