1*38d50f7bSAndrew Rist /**************************************************************
2cdf0e10cSrcweir *
3*38d50f7bSAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*38d50f7bSAndrew Rist * or more contributor license agreements. See the NOTICE file
5*38d50f7bSAndrew Rist * distributed with this work for additional information
6*38d50f7bSAndrew Rist * regarding copyright ownership. The ASF licenses this file
7*38d50f7bSAndrew Rist * to you under the Apache License, Version 2.0 (the
8*38d50f7bSAndrew Rist * "License"); you may not use this file except in compliance
9*38d50f7bSAndrew Rist * with the License. You may obtain a copy of the License at
10*38d50f7bSAndrew Rist *
11*38d50f7bSAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0
12*38d50f7bSAndrew Rist *
13*38d50f7bSAndrew Rist * Unless required by applicable law or agreed to in writing,
14*38d50f7bSAndrew Rist * software distributed under the License is distributed on an
15*38d50f7bSAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*38d50f7bSAndrew Rist * KIND, either express or implied. See the License for the
17*38d50f7bSAndrew Rist * specific language governing permissions and limitations
18*38d50f7bSAndrew Rist * under the License.
19*38d50f7bSAndrew Rist *
20*38d50f7bSAndrew Rist *************************************************************/
21*38d50f7bSAndrew Rist
22*38d50f7bSAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir #ifndef SC_SELECTIONSTATE_HXX
25cdf0e10cSrcweir #define SC_SELECTIONSTATE_HXX
26cdf0e10cSrcweir
27cdf0e10cSrcweir #include <editeng/editdata.hxx>
28cdf0e10cSrcweir #include "rangelst.hxx"
29cdf0e10cSrcweir
30cdf0e10cSrcweir // ============================================================================
31cdf0e10cSrcweir
32cdf0e10cSrcweir /** Enumerates all possible types of selections in a Calc document. */
33cdf0e10cSrcweir enum ScSelectionType
34cdf0e10cSrcweir {
35cdf0e10cSrcweir SC_SELECTTYPE_NONE, /// No selection, simple cell cursor.
36cdf0e10cSrcweir SC_SELECTTYPE_SHEET, /// Single cell, cell range, or multi range selection.
37cdf0e10cSrcweir SC_SELECTTYPE_EDITCELL, /// Cell in edit mode (with or without selection).
38cdf0e10cSrcweir SC_SELECTTYPE_DRAWING, /// One or more drawing objects.
39cdf0e10cSrcweir SC_SELECTTYPE_EDITDRAW /// Edit mode in drawing object (with or without selection).
40cdf0e10cSrcweir };
41cdf0e10cSrcweir
42cdf0e10cSrcweir // ----------------------------------------------------------------------------
43cdf0e10cSrcweir
44cdf0e10cSrcweir class ScViewData;
45cdf0e10cSrcweir
46cdf0e10cSrcweir /** Contains all available data about any possible selection in a Calc document. */
47cdf0e10cSrcweir class ScSelectionState
48cdf0e10cSrcweir {
49cdf0e10cSrcweir public:
50cdf0e10cSrcweir explicit ScSelectionState( ScViewData& rViewData );
51cdf0e10cSrcweir
52cdf0e10cSrcweir /** Returns the type of the selection this object contains. */
GetSelectionType() const53cdf0e10cSrcweir inline ScSelectionType GetSelectionType() const { return meType; }
54cdf0e10cSrcweir
55cdf0e10cSrcweir /** Returns the position of the cell cursor. */
GetCellCursor() const56cdf0e10cSrcweir inline const ScAddress& GetCellCursor() const { return maCursor; }
57cdf0e10cSrcweir /** Returns a range list containing all selected cell ranges. */
GetSheetSelection() const58cdf0e10cSrcweir inline const ScRangeList& GetSheetSelection() const { return maSheetSel; }
59cdf0e10cSrcweir /** Returns the edit engine selection. */
GetEditSelection() const60cdf0e10cSrcweir inline const ESelection& GetEditSelection() const { return maEditSel; }
61cdf0e10cSrcweir
62cdf0e10cSrcweir private:
63cdf0e10cSrcweir ScSelectionType meType; /// Type of the selection.
64cdf0e10cSrcweir ScAddress maCursor; /// Cell cursor position.
65cdf0e10cSrcweir ScRangeList maSheetSel; /// Sheet selection.
66cdf0e10cSrcweir ESelection maEditSel; /// Selection in edit mode.
67cdf0e10cSrcweir };
68cdf0e10cSrcweir
69cdf0e10cSrcweir bool operator==( const ScSelectionState& rL, const ScSelectionState& rR );
operator !=(const ScSelectionState & rL,const ScSelectionState & rR)70cdf0e10cSrcweir inline bool operator!=( const ScSelectionState& rL, const ScSelectionState& rR ) { return !(rL == rR); }
71cdf0e10cSrcweir
72cdf0e10cSrcweir // ============================================================================
73cdf0e10cSrcweir
74cdf0e10cSrcweir #endif
75cdf0e10cSrcweir
76