selection.h

/*
For general Scribus (>=1.3.2) copyright and licensing information please refer
to the COPYING file provided with the program. Following this notice may exist
a copyright and/or license notice that predates the release of Scribus 1.3.2
for which a new license (GPL+exception) is in place.
*/
/***************************************************************************
    copyright            : (C) 2005 by Craig Bradney
    email                : cbradney@zip.com.au
***************************************************************************/

/***************************************************************************
*                                                                         *
*   This program is free software; you can redistribute it and/or modify  *
*   it under the terms of the GNU General Public License as published by  *
*   the Free Software Foundation; either version 2 of the License, or     *
*   (at your option) any later version.                                   *
*                                                                         *
***************************************************************************/
#ifndef SELECTION_H
#define SELECTION_H

#include <QList>
#include <QMap>
#include <QObject>
#include <QPointer>
#include <QRectF>

#include "pageitem.h"
#include "scribusapi.h"

typedef QList< QPointer<PageItem> > SelectionList;

class SCRIBUS_API Selection : public QObject
{
    Q_OBJECT
    public:
        explicit Selection(QObject* parent);   // otherwise implicit conversion Selection* -> Selection& is possible
        Selection(QObject* parent, bool guiSelection);
        Selection(const Selection& other);
        Selection& operator=( const Selection & );
        ~Selection();

        void copy(Selection& other, bool emptyOther);
        
        bool connectItemToGUI();
        bool disconnectAllItemsFromGUI();
        bool addItem(PageItem *item, bool ignoreGUI=false);
        bool prependItem(PageItem *item, bool doEmit=true);

        bool containsItem(PageItem *item) const { return m_SelList.contains(item); }
        bool addGroup();
        bool removeItem(PageItem *item);
        bool removeFirst();
        bool removeGroup();
        PageItem* takeItem(int itemIndex);
        int findItem(PageItem *item) const { return m_SelList.indexOf(item); }
        int count() const { return m_SelList.count(); }
        bool isEmpty() const { return m_SelList.count()==0; }
        bool clear();
        bool primarySelectionIs(const PageItem* item) const { return (!m_SelList.isEmpty() && (item==m_SelList.first())); }
        const SelectionList& selectionList() const {return m_SelList;}
        PageItem *itemAt(int index=0) { return itemAt_(index); }
        const PageItem *itemAt(int index=0) const { return const_cast<Selection*>(this)->itemAt_(index); }
        QList<PageItem*> items() const;
        QStringList getSelectedItemsByName() const;
        bool isMultipleSelection() const { return (m_SelList.count() > 1); }
        bool isGUISelection() const { return m_isGUISelection; }
        double width() const;
        double height() const;
        //set the group rectangle properties
        void setGroupRect();
        void getGroupRect(double *x, double *y, double *w, double *h);
        QRectF getGroupRect();
        void getVisualGroupRect(double *x, double *y, double *w, double *h);
        QRectF getVisualGroupRect();
        bool itemsAreSameType() const;

        int objectsLayer(void) const;

        bool objectsHaveSameParent(void) const;

        bool signalsDelayed(void);
        void delaySignalsOn(void);
        void delaySignalsOff(void);
        
    protected:
        PageItem *itemAt_(int index=0);
        SelectionList m_SelList;
        bool m_isGUISelection;
        double groupX;
        double groupY;
        double groupW;
        double groupH;
        
        double visualGX;
        double visualGY;
        double visualGW;
        double visualGH;

        int  m_delaySignals;
        bool m_sigSelectionChanged;
        bool m_sigSelectionIsMultiple;

        void sendSignals(bool guiConnect = true);
        
    signals:
        void selectionIsMultiple(bool);
        void empty();
        void selectionChanged();
};

#endif