KWFrameViewManager.h

/* This file is part of the KOffice project
 * Copyright (C) 2005 Thomas Zander <zander@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 as published by the Free Software Foundation; version 2.
 
 * 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 kwframeviewmanager_h
#define kwframeviewmanager_h
#include <tqobject.h>
#include <tqptrlist.h>
#include <tqvaluelist.h>
#include <tqvaluevector.h>
#include <defs.h>
 
class KWDocument;
class KWFrame;
class KWFrameSet;
class KWView;
class KWViewMode;
class KWFramesListener;
class KWFrameSetEdit;
class KWFrameView;
 
class KoPoint;
class KoRect;
 
class TQPointer;
class TQRegion;

class KWFrameViewManager : public TQObject {
    TQ_OBJECT
  
 
public:
    KWFrameViewManager();
    KWFrameViewManager(KWDocument *doc);
    virtual ~KWFrameViewManager();

    enum SelectionType { selected, unselected, nextUnselected, frameOnTop };
    KWFrameView *view(const KoPoint &point, SelectionType select, bool borderOnly = false) const;
    KWFrameView *view(const KWFrame *frame) const;

    TQValueList<KWFrameView*> selectedFrames() const;
    KWFrameView* selectedFrame() const;
 
    // this should be changed to a real iterator
    const TQValueList<KWFrameView*> frameViewsIterator() const { return m_frames; }

    MouseMeaning mouseMeaning( const KoPoint &point, int keyState) const;
    TQCursor mouseCursor( const KoPoint &point, int keyState ) const;

    void showPopup( const KoPoint &point, KWView *view, int keyState, const TQPoint &popupPoint) const;
 
    // listeners; see the fireEvents method signature for more info.
    void addKWFramesListener(KWFramesListener *listener);
    void removeKWFramesListener(KWFramesListener *listener);

    void selectFrames(const KoPoint &point, int keyState, bool leftClick);
 
public slots:
    void slotFrameSetAdded(KWFrameSet *fs);
    void slotFrameSetRemoved(KWFrameSet *fs);
    void slotFrameAdded(KWFrame *f);
    void slotFrameRemoved(KWFrame *f);
    void slotFrameMoved(KWFrame *f, double previousYPosition);
    void slotFrameResized(KWFrame *f);
    void slotFrameSelectionChanged();
    void slotFrameSetRenamed(KWFrameSet *fs);
 
signals:
    void sigFrameSelectionChanged();
    void sigFrameSetRenamed();
    void sigFrameResized(const TQValueList<KWFrame*>&);
    void sigFrameMoved(const TQValueList<KWFrame*>&);
 
protected slots:
    void fireEvents();
 
protected:
#ifndef NDEBUG
    virtual
#endif
    void requestFireEvents();
 
private:
    class FrameEvent {
        public:
            enum ActionType { FrameRemoved, FrameAdded, FrameSetRemoved, FrameSetAdded, FrameMoved,
                FrameResized, FrameSelectionChanged, FrameSetRenamed };
            FrameEvent (ActionType action);
            FrameEvent (ActionType action, KWFrame *frame);
            FrameEvent (ActionType action, KWFrameSet *frameSet);
        private:
            ActionType m_action;
            KWFrame *m_frame;
            KWFrameSet *m_frameSet;
        friend class KWFrameViewManager;
    };

    void recalculateFrameCache();

    TQValueVector<KWFrameView*> framesAt(const KoPoint &point, bool borderOnly = false) const;
    static bool compareFrameViewZOrder(KWFrameView *f1, KWFrameView *f2);
 
private:
    TQValueList<KWFrameView*> m_frames; // TODO TQHash<KWFrame*,KWFrameView*>
    TQValueList<KWFramesListener*> m_framesListener;
    TQValueList<FrameEvent*> m_frameEvents;
    bool m_queueRequested, m_blockEvents;
};
 
class KWFramesListener {
public:
    virtual void frameSetAdded(KWFrameSet *fs) = 0;
    virtual void frameSetRemoved(KWFrameSet *fs) = 0;
    virtual void frameAdded(KWFrame *f) = 0;
    virtual void frameRemoved(KWFrame *f) = 0;
};
 
#endif