Subversion Repositories Scribus

Rev

Rev 4147 | Rev 4430 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
3903 cbradney 1
/***************************************************************************
2
        copyright            : (C) 2005 by Craig Bradney
3
        email                : cbradney@zip.com.au
4
***************************************************************************/
5
 
6
/***************************************************************************
7
*                                                                         *
8
*   This program is free software; you can redistribute it and/or modify  *
9
*   it under the terms of the GNU General Public License as published by  *
10
*   the Free Software Foundation; either version 2 of the License, or     *
11
*   (at your option) any later version.                                   *
12
*                                                                         *
13
***************************************************************************/
14
#ifndef SELECTION_H
15
#define SELECTION_H
16
 
17
#include <qguardedptr.h>
18
#include <qobject.h>
19
#include <qmap.h>
20
#include <qvaluevector.h>
21
 
22
#include "pageitem.h"
3938 cbradney 23
#include "scribusapi.h"
3903 cbradney 24
 
25
typedef QValueList< QGuardedPtr<PageItem> > SelectionList;
26
 
3937 cbradney 27
class SCRIBUS_API Selection : public QObject
3903 cbradney 28
{
29
        Q_OBJECT
30
        public:
4135 cbradney 31
                /**
32
                 * Create an empty selection that is not a GUI selection
33
                 * @param  parent
34
                 * @return Selection
35
                 */
4133 cbradney 36
                Selection(QObject*);
4135 cbradney 37
                /**
38
                 * Create an empty selection that may be a GUI selection
39
                 * @param  parent
40
                 * @param  If the selection is to be a GUI selection
41
                 * @return Selection
42
                 */
4133 cbradney 43
                Selection(QObject*, bool);
4135 cbradney 44
                /**
45
                 * Copy a selection
46
                 * NOTE: We are leaving the connections of the items in place
47
                 * and the isGUISelection set in the copy. We cannot disconnect them
48
                 * as they may be connected via the main GUI selection.
49
                 * @param  Other selection
50
                 * @return New selection
51
                 */
4130 cbradney 52
                Selection(const Selection&);
4147 cbradney 53
                Selection& operator=( const Selection & );
3903 cbradney 54
                ~Selection();
55
 
4133 cbradney 56
                bool connectItemToGUI();
3903 cbradney 57
                /**
58
                 * Disconnect all items from the GUI slots.
59
                 * This should not really be necessary if all things are going ok
60
                 * except for within the clearAll function.
61
                 * @return
62
                 */
63
                bool disconnectAllItemsFromGUI();
3936 cbradney 64
                /**
65
                 * @brief Add an item to the selection.
4135 cbradney 66
                 * If its added to a GUI selection selection and its item 0, its connected to the GUI too
3936 cbradney 67
                 * @param item Item to add
4280 cbradney 68
                 * @param ignoreGUI Dont connect Item To GUI even if this is a GUI selection
3936 cbradney 69
                 * @return If the item was added
70
                 */
4280 cbradney 71
                bool addItem(PageItem *item, bool ignoreGUI=false);
3936 cbradney 72
                /**
73
                 * @brief Prepend an item to the selection.
4135 cbradney 74
                 * If its added to a GUI selection selection and its item 0, its connected to the GUI too
3936 cbradney 75
                 * @param item Item to add
76
                 * @return If the item was added
77
                 */
4133 cbradney 78
                bool prependItem(PageItem *item);
3936 cbradney 79
                /**
80
                 * Unused
81
                 * @return
82
                 */
3903 cbradney 83
                bool addGroup();
3936 cbradney 84
                /**
4135 cbradney 85
                 * Remove an item from list
3936 cbradney 86
                 * @param item
87
                 * @return
88
                 */
4133 cbradney 89
                bool removeItem(PageItem *item);
3936 cbradney 90
                /**
91
                 * Remove the first item from the list
92
                 * @return If the remove was successful
93
                 */
4133 cbradney 94
                bool removeFirst();
3936 cbradney 95
                /**
96
                 * Unused
97
                 * @return
98
                 */
3903 cbradney 99
                bool removeGroup();
3936 cbradney 100
                /**
101
                 * Remove an item from list listNumber and return a pointer to it
102
                 * @param itemIndex Index of the item in the list
103
                 * @return Item
104
                 */
4133 cbradney 105
                PageItem* takeItem(uint itemIndex);
3936 cbradney 106
                /**
4135 cbradney 107
                 * Find an item from the selection and return an index to it
3936 cbradney 108
                 * @param item Item pointer to find in the list
109
                 * @return Item
110
                 */
4134 cbradney 111
                int findItem(PageItem *item) const { return m_SelList.findIndex(item); }
3936 cbradney 112
                /**
4135 cbradney 113
                 * Return the count of the selection
3936 cbradney 114
                 * @return
115
                 */
4134 cbradney 116
                uint count() const { return m_SelList.count(); }
3936 cbradney 117
                /**
4135 cbradney 118
                 * Check if the selection is empty.
3939 cbradney 119
                 * @return
3936 cbradney 120
                 */
4135 cbradney 121
                bool isEmpty() const { return m_SelList.count()==0; }
3936 cbradney 122
                /**
123
                 * Clear a list
124
                 * @return
125
                 */
4133 cbradney 126
                bool clear();
3903 cbradney 127
                /**
3936 cbradney 128
                 * See if the first selected item is "me", usually called from an item object with "this".
3903 cbradney 129
                 * @param item
130
                 * @return
131
                 */
4134 cbradney 132
                bool primarySelectionIs(const PageItem* item) const { return (!m_SelList.isEmpty() && (item==m_SelList.first())); }
4133 cbradney 133
                PageItem *itemAt(int index=0);
134
                QStringList getSelectedItemsByName();
135
                bool isMultipleSelection() const { return m_hasGroupSelection; }
136
                bool isGUISelection() const { return m_isGUISelection; }
137
                void setIsGUISelection(bool guiSelection) { m_isGUISelection=guiSelection; }
3903 cbradney 138
 
139
        protected:
4133 cbradney 140
                SelectionList m_SelList;
141
                bool m_hasGroupSelection;
142
                bool m_isGUISelection;
4049 cbradney 143
 
144
        signals:
4130 cbradney 145
                void selectionIsMultiple(bool);
3903 cbradney 146
};
147
 
148
#endif