sc/source/ui/inc/selectionstate.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SC_SOURCE_UI_INC_SELECTIONSTATE_HXX
  21 #define INCLUDED_SC_SOURCE_UI_INC_SELECTIONSTATE_HXX
  22
  23 #include <editeng/editdata.hxx>
  24 #include "rangelst.hxx"
  25
  26 /** Enumerates all possible types of selections in a Calc document. */
  27 enum ScSelectionType
  28 {
  29     SC_SELECTTYPE_NONE,             /// No selection, simple cell cursor.
  30     SC_SELECTTYPE_SHEET,            /// Single cell, cell range, or multi range selection.
  31     SC_SELECTTYPE_EDITCELL,         /// Cell in edit mode (with or without selection).
  32     SC_SELECTTYPE_DRAWING,          /// One or more drawing objects.
  33     SC_SELECTTYPE_EDITDRAW          /// Edit mode in drawing object (with or without selection).
  34 };
  35
  36 class ScViewData;
  37
  38 /** Contains all available data about any possible selection in a Calc document. */
  39 class ScSelectionState
  40 {
  41 public:
  42     explicit            ScSelectionState( ScViewData& rViewData );
  43
  44     /** Returns the type of the selection this object contains. */
  45     inline ScSelectionType GetSelectionType() const { return meType; }
  46
  47     /** Returns the position of the cell cursor. */
  48     inline const ScAddress& GetCellCursor() const { return maCursor; }
  49     /** Returns a range list containing all selected cell ranges. */
  50     inline const ScRangeList& GetSheetSelection() const { return maSheetSel; }
  51     /** Returns the edit engine selection. */
  52     inline const ESelection& GetEditSelection() const { return maEditSel; }
  53
  54 private:
  55     ScSelectionType     meType;             /// Type of the selection.
  56     ScAddress           maCursor;           /// Cell cursor position.
  57     ScRangeList         maSheetSel;         /// Sheet selection.
  58     ESelection          maEditSel;          /// Selection in edit mode.
  59 };
  60
  61 bool operator==( const ScSelectionState& rL, const ScSelectionState& rR );
  62 inline bool operator!=( const ScSelectionState& rL, const ScSelectionState& rR ) { return !(rL == rR); }
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */