blob: 57aaf9293301541ebb028873fe788d753aad03ce (
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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 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>
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
{
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 pages of the SdDrawDocument they describe and issue
redraw requests where necessary.
*/
void UpdateAllPages (void);
void SelectPage (int nPageIndex);
/** Select the descriptor that is associated with the given page.
*/
void SelectPage (const SdPage* pPage);
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.
*/
void DeselectPage (int nPageIndex);
void DeselectPage (const model::SharedPageDescriptor& rpDescriptor);
/** 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;
void PrepareModelChange (void);
void HandleModelChange (void);
/** 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 (bool bMakeSelectionVisible = true);
/** Disable the broadcasting o selectio change events. Subsequent
changes of the selection will set a flag that triggers the sending
of events when EnableBroadcasting() is called.
*/
void DisableBroadcasting (void);
/** Return the descriptor of the most recently selected page. This
works only when the page has not been de-selected in the mean time.
This method helps the view when it scrolls the selection into the
visible area.
@return
When the selection is empty or when the most recently selected
page has been deselected already (but other pages are still
selected) then NULL is returned, even when a selection did exist
but has been cleared.
*/
model::SharedPageDescriptor GetMostRecentlySelectedPage (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.
*/
void SetPageSelection (const ::boost::shared_ptr<PageSelection>& rSelection);
void UpdateCurrentPage (const model::SharedPageDescriptor& rCurrentPageDescriptor);
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;
void CountSelectedPages (void);
};
} } } // end of namespace ::sd::slidesorter::controller
#endif
|
