sc/source/ui/inc/uiitems.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 #pragma once
  21
  22 #include <scdllapi.h>
  23 #include <sortparam.hxx>
  24 #include <subtotalparam.hxx>
  25 #include <paramisc.hxx>
  26 #include <svl/poolitem.hxx>
  27
  28 #include <memory>
  29 #include <vector>
  30
  31 namespace editeng {
  32     struct MisspellRanges;
  33 }
  34
  35 class ScEditEngineDefaulter;
  36 class EditTextObject;
  37 class ScViewData;
  38 class ScDPSaveData;
  39 struct ScQueryParam;
  40
  41 //  Items
  42
  43 class ScInputStatusItem : public SfxPoolItem
  44 {
  45     ScAddress           aCursorPos;
  46     ScAddress           aStartPos;
  47     ScAddress           aEndPos;
  48     OUString            aString;
  49     std::unique_ptr<EditTextObject>             pEditData;
  50     const std::vector<editeng::MisspellRanges>* mpMisspellRanges;
  51
  52 public:
  53
  54                             ScInputStatusItem( sal_uInt16 nWhich,
  55                                                const ScAddress& rCurPos,
  56                                                const ScAddress& rStartPos,
  57                                                const ScAddress& rEndPos,
  58                                                OUString aString,
  59                                                const EditTextObject* pData );
  60                             ScInputStatusItem( const ScInputStatusItem& rItem );
  61                             virtual ~ScInputStatusItem() override;
  62
  63     virtual bool            operator==( const SfxPoolItem& ) const override;
  64     virtual ScInputStatusItem* Clone( SfxItemPool *pPool = nullptr ) const override;
  65
  66     const ScAddress&        GetPos() const      { return aCursorPos; }
  67
  68     const OUString&         GetString() const   { return aString; }
  69     const EditTextObject*   GetEditData() const { return pEditData.get(); }
  70
  71     void SetMisspellRanges( const std::vector<editeng::MisspellRanges>* pRanges );
  72     const std::vector<editeng::MisspellRanges>* GetMisspellRanges() const { return mpMisspellRanges;}
  73 };
  74
  75 #define SC_TAB_INSERTED     1
  76 #define SC_TAB_DELETED      2
  77 #define SC_TAB_MOVED        3
  78 #define SC_TAB_COPIED       4
  79 #define SC_TAB_HIDDEN       5
  80 #define SC_TABS_INSERTED    6
  81 #define SC_TABS_DELETED     7
  82
  83 class ScTablesHint final : public SfxHint
  84 {
  85     sal_uInt16 nId;
  86     SCTAB nTab1;
  87     SCTAB nTab2;
  88
  89 public:
  90                     ScTablesHint(sal_uInt16 nNewId, SCTAB nTable1, SCTAB nTable2=0);
  91                     virtual ~ScTablesHint() override;
  92
  93     sal_uInt16      GetTablesHintId() const { return nId; }
  94     SCTAB           GetTab1() const         { return nTab1; }
  95     SCTAB           GetTab2() const         { return nTab2; }
  96 };
  97
  98 class ScEditViewHint final : public SfxHint
  99 {
 100     ScEditEngineDefaulter*  pEditEngine;
 101     ScAddress                   aCursorPos;
 102
 103 public:
 104                     ScEditViewHint() = delete;
 105                     ScEditViewHint( ScEditEngineDefaulter* pEngine, const ScAddress& rCurPos );
 106                     virtual ~ScEditViewHint() override;
 107
 108     SCCOL           GetCol() const      { return aCursorPos.Col(); }
 109     SCROW           GetRow() const      { return aCursorPos.Row(); }
 110     SCTAB           GetTab() const      { return aCursorPos.Tab(); }
 111     ScEditEngineDefaulter*  GetEngine() const   { return pEditEngine; }
 112 };
 113
 114 class ScIndexHint : public SfxHint
 115 {
 116     sal_uInt16 nIndex;
 117
 118 public:
 119                     ScIndexHint(SfxHintId nNewId, sal_uInt16 nIdx);
 120                     virtual ~ScIndexHint() override;
 121
 122     sal_uInt16      GetIndex() const        { return nIndex; }
 123 };
 124
 125 // Parameter item for the sort dialog:
 126
 127 class SC_DLLPUBLIC ScSortItem : public SfxPoolItem
 128 {
 129 public:
 130                             ScSortItem( sal_uInt16              nWhich,
 131                                         ScViewData*         ptrViewData,
 132                                         const ScSortParam*  pSortData );
 133                             ScSortItem( sal_uInt16              nWhich,
 134                                         const ScSortParam*  pSortData );
 135
 136     virtual bool            operator==( const SfxPoolItem& ) const override;
 137     virtual ScSortItem*     Clone( SfxItemPool *pPool = nullptr ) const override;
 138     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
 139
 140     ScViewData*         GetViewData () const { return pViewData; }
 141     const ScSortParam&  GetSortData () const { return theSortData; }
 142
 143 private:
 144     ScViewData*     pViewData;
 145     ScSortParam     theSortData;
 146 };
 147
 148 class SC_DLLPUBLIC ScQueryItem : public SfxPoolItem
 149 {
 150 public:
 151                             ScQueryItem( sal_uInt16                 nWhich,
 152                                          ScViewData*            ptrViewData,
 153                                          const ScQueryParam*    pQueryData );
 154                             ScQueryItem( sal_uInt16                 nWhich,
 155                                          const ScQueryParam*    pQueryData );
 156                             ScQueryItem( const ScQueryItem& rItem );
 157                             virtual ~ScQueryItem() override;
 158
 159     virtual bool            operator==( const SfxPoolItem& ) const override;
 160     virtual ScQueryItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
 161
 162     ScViewData*         GetViewData () const { return pViewData; }
 163     const ScQueryParam& GetQueryData() const;
 164
 165     bool        GetAdvancedQuerySource(ScRange& rSource) const;
 166     void        SetAdvancedQuerySource(const ScRange* pSource);
 167
 168 private:
 169     std::unique_ptr<ScQueryParam> mpQueryData;
 170     ScViewData*     pViewData;
 171     ScRange         aAdvSource;
 172     bool            bIsAdvanced;
 173 };
 174
 175 class SC_DLLPUBLIC ScSubTotalItem : public SfxPoolItem
 176 {
 177 public:
 178                 ScSubTotalItem( sal_uInt16                  nWhich,
 179                                 ScViewData*             ptrViewData,
 180                                 const ScSubTotalParam*  pSubTotalData );
 181
 182     virtual bool            operator==( const SfxPoolItem& ) const override;
 183     virtual ScSubTotalItem* Clone( SfxItemPool *pPool = nullptr ) const override;
 184     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
 185
 186     ScViewData*             GetViewData () const { return pViewData; }
 187     const ScSubTotalParam&  GetSubTotalData() const { return theSubTotalData; }
 188
 189 private:
 190     ScViewData*     pViewData;
 191     ScSubTotalParam theSubTotalData;
 192 };
 193
 194 class SC_DLLPUBLIC ScUserListItem : public SfxPoolItem
 195 {
 196 public:
 197                 ScUserListItem( sal_uInt16 nWhich );
 198                 ScUserListItem( const ScUserListItem& rItem );
 199                 virtual ~ScUserListItem() override;
 200
 201     virtual bool            operator==( const SfxPoolItem& ) const override;
 202     virtual ScUserListItem* Clone( SfxItemPool *pPool = nullptr ) const override;
 203
 204     void        SetUserList ( const ScUserList& rUserList );
 205     ScUserList* GetUserList () const { return pUserList.get(); }
 206
 207 private:
 208     std::unique_ptr<ScUserList> pUserList;
 209 };
 210
 211 class ScConsolidateItem : public SfxPoolItem
 212 {
 213 public:
 214                 ScConsolidateItem( sal_uInt16                    nWhich,
 215                                    const ScConsolidateParam* pParam );
 216
 217     virtual bool            operator==( const SfxPoolItem& ) const override;
 218     virtual ScConsolidateItem* Clone( SfxItemPool *pPool = nullptr ) const override;
 219
 220     const ScConsolidateParam& GetData() const { return theConsData; }
 221
 222 private:
 223     ScConsolidateParam  theConsData;
 224 };
 225
 226 class ScPivotItem : public SfxPoolItem
 227 {
 228 public:
 229                 ScPivotItem( sal_uInt16 nWhich, const ScDPSaveData* pData,
 230                              const ScRange* pRange, bool bNew );
 231                 ScPivotItem( const ScPivotItem& rItem );
 232                 virtual ~ScPivotItem() override;
 233
 234     virtual bool            operator==( const SfxPoolItem& ) const override;
 235     virtual ScPivotItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
 236
 237     const ScDPSaveData& GetData() const         { return *pSaveData; }
 238     const ScRange&      GetDestRange() const    { return aDestRange; }
 239     bool                IsNewSheet() const      { return bNewSheet; }
 240
 241 private:
 242     std::unique_ptr<ScDPSaveData>  pSaveData;
 243     ScRange                        aDestRange;
 244     bool                           bNewSheet;
 245 };
 246
 247 class ScSolveItem : public SfxPoolItem
 248 {
 249 public:
 250                 ScSolveItem( sal_uInt16              nWhich,
 251                              const ScSolveParam* pParam );
 252
 253     virtual bool            operator==( const SfxPoolItem& ) const override;
 254     virtual ScSolveItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
 255
 256     const ScSolveParam& GetData() const { return theSolveData; }
 257
 258 private:
 259     ScSolveParam    theSolveData;
 260 };
 261
 262 class ScTabOpItem : public SfxPoolItem
 263 {
 264 public:
 265                 ScTabOpItem( sal_uInt16              nWhich,
 266                              const ScTabOpParam* pParam );
 267
 268     virtual bool            operator==( const SfxPoolItem& ) const override;
 269     virtual ScTabOpItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
 270
 271     const ScTabOpParam& GetData() const { return theTabOpData; }
 272
 273 private:
 274     ScTabOpParam    theTabOpData;
 275 };
 276
 277 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */