sheetevents.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_SC_INC_SHEETEVENTS_HXX
#define INCLUDED_SC_INC_SHEETEVENTS_HXX

#include <rtl/ustring.hxx>
#include <memory>

#include <optional>

enum class ScSheetEventId {
    FOCUS, UNFOCUS, SELECT, DOUBLECLICK, RIGHTCLICK, CHANGE, CALCULATE, COUNT,
    NOTFOUND = -1 // used as an error return value
};

class ScSheetEvents
{
    std::unique_ptr<std::optional<OUString>[]> mpScriptNames;

    void        Clear();

public:
                ScSheetEvents();
                ScSheetEvents(const ScSheetEvents& rOther);
                ~ScSheetEvents();

    ScSheetEvents&          operator= (const ScSheetEvents& rOther);

    const OUString*         GetScript(ScSheetEventId nEvent) const;
    void                    SetScript(ScSheetEventId nEvent, const OUString* pNew);

    static OUString         GetEventName(ScSheetEventId nEvent);
    static sal_Int32        GetVbaSheetEventId(ScSheetEventId nEvent);
    static sal_Int32        GetVbaDocumentEventId(ScSheetEventId nEvent);
};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */