sc/inc/sheetevents.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 <rtl/ustring.hxx>
  23 #include <memory>
  24
  25 #include <optional>
  26
  27 enum class ScSheetEventId {
  28     FOCUS, UNFOCUS, SELECT, DOUBLECLICK, RIGHTCLICK, CHANGE, CALCULATE, COUNT,
  29     NOTFOUND = -1 // used as an error return value
  30 };
  31
  32 class ScSheetEvents
  33 {
  34     std::unique_ptr<std::optional<OUString>[]> mpScriptNames;
  35
  36     void        Clear();
  37
  38 public:
  39                 ScSheetEvents();
  40                 ScSheetEvents(const ScSheetEvents& rOther);
  41                 ~ScSheetEvents();
  42
  43     ScSheetEvents&          operator= (const ScSheetEvents& rOther);
  44
  45     const OUString*         GetScript(ScSheetEventId nEvent) const;
  46     void                    SetScript(ScSheetEventId nEvent, const OUString* pNew);
  47
  48     static OUString         GetEventName(ScSheetEventId nEvent);
  49     static sal_Int32        GetVbaSheetEventId(ScSheetEventId nEvent);
  50     static sal_Int32        GetVbaDocumentEventId(ScSheetEventId nEvent);
  51 };
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */