blob: 4d439d89402564209435371b3730961ef5a99ce6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef SD_SLIDESORTER_PAGE_SELECTOR_HXX
#define SD_SLIDESORTER_PAGE_SELECTOR_HXX
#include "model/SlsSharedPageDescriptor.hxx"
#include <com/sun/star/drawing/XDrawPage.hpp>
#include <vector>
#include <memory>
#include <boost/noncopyable.hpp>
class SdPage;
namespace sd { namespace slidesorter {
class SlideSorter;
} }
namespace sd { namespace slidesorter { namespace model {
class SlideSorterModel;
} } }
namespace sd { namespace slidesorter { namespace view {
class SlideSorterView;
} } }
namespace sd { namespace slidesorter { namespace controller {
class SlideSorterController;
/** A sub-controller that handles page selection of the slide browser.
Selecting a page does not make it the current page (of the main view)
automatically as this would not be desired in a multi selection. This
has to be done explicitly by calling the
CurrentSlideManager::SetCurrentSlide() method.
Indices of pages relate allways to the number of all pages in the model
(as returned by GetPageCount()) not just the selected pages.
*/
class PageSelector : private ::boost::noncopyable
{
public:
PageSelector (SlideSorter& rSlideSorter);
void SelectAllPages (void);
void DeselectAllPages (void);
/** Update the selection state of all page descriptors to be the same as
that of the corresponding pages of the SdPage objects and issue
redraw requests where necessary.
*/
void GetCoreSelection (void);
/** Update the selection state of the SdPage objects to be the same as
that of the correspinding page descriptors.
*/
void SetCoreSelection (void);
/** Select the specified descriptor. The selection state of the other
descriptors is not affected.
*/
void SelectPage (int nPageIndex);
/** Select the descriptor that is associated with the given page. The
selection state of the other descriptors is not affected.
*/
void SelectPage (const SdPage* pPage);
/** Select the specified descriptor. The selection state of the other
descriptors is not affected.
*/
void SelectPage (const model::SharedPageDescriptor& rpDescriptor);
/** Return whether the specified page is selected. This convenience
method is a subsitute for
SlideSorterModel::GetPageDescriptor(i)->IsSelected() is included
here to make this class more self contained.
*/
bool IsPageSelected (int nPageIndex);
/** Deselect the descriptor that is associated with the given page.
@param bUpdateCurrentPage
When <TRUE/> then the current page is updated to the first slide
of the remaining selection.
*/
void DeselectPage (
int nPageIndex,
const bool bUpdateCurrentPage = true);
void DeselectPage (
const SdPage* pPage,
const bool bUpdateCurrentPage = true);
void DeselectPage (
const model::SharedPageDescriptor& rpDescriptor,
const bool bUpdateCurrentPage = true);
/** This convenience method returns the same number of pages that
SlideSorterModel.GetPageCount() returns. It is included here so
that it is self contained for iterating over all pages to select or
deselect them.
*/
int GetPageCount (void) const;
int GetSelectedPageCount (void) const;
/** Return the anchor for a range selection. This usually is the first
selected page after all pages have been deselected.
@return
The returned anchor may be NULL.
*/
model::SharedPageDescriptor GetSelectionAnchor (void) const;
typedef ::std::vector<SdPage*> PageSelection;
/** Return an object that describes the current selection. The caller
can use that object to later restore the selection.
@return
The object returned describes the selection via indices. So
even if pages are exchanged a later call to SetPageSelection()
is valid.
*/
::boost::shared_ptr<PageSelection> GetPageSelection (void) const;
/** Restore a page selection according to the given selection object.
@param rSelection
Typically obtained by calling GetPageSelection() this object
is used to restore the selection. If pages were exchanged since
the last call to GetPageSelection() it is still valid to call
this method with the selection. When pages have been inserted
or removed the result may be unexpected.
@param bUpdateCurrentPage
When <TRUE/> (the default value) then after setting the
selection update the current page to the first page of the
selection.
When called from within UpdateCurrentPage() then this flag is
used to prevent a recursion loop.
*/
void SetPageSelection (
const ::boost::shared_ptr<PageSelection>& rSelection,
const bool bUpdateCurrentPage = true);
/** Call this method after the the model has changed to set the number
of selected pages.
*/
void CountSelectedPages (void);
/** Use the UpdateLock whenever you do a complex selection, i.e. call
more than one method in a row. An active lock prevents intermediate
changes of the current slide.
*/
class UpdateLock
{
public:
UpdateLock (SlideSorter& rSlideSorter);
UpdateLock (PageSelector& rPageSelector);
~UpdateLock (void);
void Release (void);
private:
PageSelector* mpSelector;
};
class BroadcastLock
{
public:
BroadcastLock (SlideSorter& rSlideSorter);
BroadcastLock (PageSelector& rPageSelector);
~BroadcastLock (void);
private:
PageSelector& mrSelector;
};
private:
model::SlideSorterModel& mrModel;
SlideSorter& mrSlideSorter;
SlideSorterController& mrController;
int mnSelectedPageCount;
int mnBroadcastDisableLevel;
bool mbSelectionChangeBroadcastPending;
model::SharedPageDescriptor mpMostRecentlySelectedPage;
/// Anchor for a range selection.
model::SharedPageDescriptor mpSelectionAnchor;
model::SharedPageDescriptor mpCurrentPage;
sal_Int32 mnUpdateLockCount;
bool mbIsUpdateCurrentPagePending;
/** Enable the broadcasting of selection change events. This calls the
SlideSorterController::SelectionHasChanged() method to do the actual
work. When EnableBroadcasting has been called as many times as
DisableBroadcasting() was called before and the selection has been
changed in the mean time, this change will be broadcasted.
*/
void EnableBroadcasting (void);
/** Disable the broadcasting of selection change events. Subsequent
changes of the selection will set a flag that triggers the sending
of events when EnableBroadcasting() is called.
*/
void DisableBroadcasting (void);
void UpdateCurrentPage (const bool bUpdateOnlyWhenPending = false);
void CheckConsistency (void) const;
};
} } } // end of namespace ::sd::slidesorter::controller
#endif
|
