Subversion Repositories Scribus

Rev

Rev 3934 | Rev 3937 | 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"
23
 
24
typedef enum {
25
        GUISelection=0,
26
        NonGUISelection=1,
27
        Delete=2,
3934 cbradney 28
        CustomStart=10,
29
        TempStart=100
3903 cbradney 30
} SelectionListType;
31
 
32
typedef QValueList< QGuardedPtr<PageItem> > SelectionList;
33
typedef QMap<int, SelectionList > ListOfSelections;
34
typedef QMap<int, bool> ListBool;
35
 
36
class Selection : public QObject
37
{
38
        Q_OBJECT
39
        public:
40
                Selection();
41
                ~Selection();
42
 
43
                void setDoc(ScribusDoc*);
44
 
45
                QPtrList<PageItem>* requestList();
3934 cbradney 46
                int backupToTempList(int listNumber);
47
                bool restoreFromTempList(int listNumber, int fromTempListNumber);
48
 
49
 
3903 cbradney 50
                bool connectItemToGUI(int listNumber);
51
                /**
52
                 * Disconnect all items from the GUI slots.
53
                 * This should not really be necessary if all things are going ok
54
                 * except for within the clearAll function.
55
                 * @return
56
                 */
57
                bool disconnectAllItemsFromGUI();
3936 cbradney 58
                /**
59
                 * @brief Add an item to the selection.
60
                 * If its added to the GUISelection listNumber and its item 0, its connected to the GUI too
61
                 * @param item Item to add
62
                 * @param listNumber List to add the item to
63
                 * @return If the item was added
64
                 */
3903 cbradney 65
                bool addItem(PageItem *item, int listNumber=GUISelection);
3936 cbradney 66
                /**
67
                 * @brief Prepend an item to the selection.
68
                 * If its added to the GUISelection listNumber and its item 0, its connected to the GUI too
69
                 * @param item Item to add
70
                 * @param listNumber List to add the item to
71
                 * @return If the item was added
72
                 */
3934 cbradney 73
                bool prependItem(PageItem *item, int listNumber=GUISelection);
3936 cbradney 74
                /**
75
                 * Unused
76
                 * @return
77
                 */
3903 cbradney 78
                bool addGroup();
3936 cbradney 79
                /**
80
                 * Remove an item from list listNumber
81
                 * @param item
82
                 * @param listNumber List to remove the item from
83
                 * @return
84
                 */
3903 cbradney 85
                bool removeItem(PageItem *item, int listNumber=GUISelection);
3936 cbradney 86
                /**
87
                 * Remove the first item from the list
88
                 * @param listNumber List to remove the item
89
                 * @return If the remove was successful
90
                 */
3934 cbradney 91
                bool removeFirst(int listNumber=GUISelection);
3936 cbradney 92
                /**
93
                 * Unused
94
                 * @return
95
                 */
3903 cbradney 96
                bool removeGroup();
3936 cbradney 97
                /**
98
                 * Remove an item from list listNumber and return a pointer to it
99
                 * @param itemIndex Index of the item in the list
100
                 * @param listNumber List to remove the item from
101
                 * @return Item
102
                 */
3934 cbradney 103
                PageItem* takeItem(int itemIndex, int listNumber=GUISelection);
3936 cbradney 104
                /**
105
                 * Find an item from list listNumber and return an index to it
106
                 * @param item Item pointer to find in the list
107
                 * @param listNumber List to find th item in
108
                 * @return Item
109
                 */
3934 cbradney 110
                const int findItem(PageItem *item, int listNumber=GUISelection);
3936 cbradney 111
                /**
112
                 * Return the count of a list
113
                 * @param listNumber List to count
114
                 * @return
115
                 */
3934 cbradney 116
                uint count(int listNumber=GUISelection);
3936 cbradney 117
                /**
118
                 *
119
                 * @param listNumber List to empty
120
                 * @return
121
                 */
3934 cbradney 122
                bool isEmpty(int listNumber=GUISelection);
3936 cbradney 123
                /**
124
                 * Clear a list
125
                 * @param listNumber List to clear
126
                 * @return
127
                 */
3903 cbradney 128
                bool clear(int listNumber=GUISelection);
129
                void clearAll();
130
                /**
3936 cbradney 131
                 * See if the first selected item is "me", usually called from an item object with "this".
3903 cbradney 132
                 * @param item
133
                 * @return
134
                 */
3934 cbradney 135
                const bool primarySelectionIsMyself(const PageItem* item, int listNumber=GUISelection);
3903 cbradney 136
                PageItem *itemAt(int index=0, int listNumber=GUISelection);
3934 cbradney 137
                QStringList getSelectedItemsByName(int listNumber=GUISelection);
3903 cbradney 138
 
139
        protected:
140
                ScribusDoc* m_Doc;
141
                ListOfSelections sellists;
142
                ListBool hasGroupSelection;
3934 cbradney 143
                int nextTemp;
3903 cbradney 144
};
145
 
146
#endif