include/svx/ActionDescriptionProvider.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_SVX_ACTIONDESCRIPTIONPROVIDER_HXX
  21 #define INCLUDED_SVX_ACTIONDESCRIPTIONPROVIDER_HXX
  22
  23 #include <config_options.h>
  24 #include <rtl/ustring.hxx>
  25 #include <svx/svxdllapi.h>
  26
  27
  28 /** This class provides localized descriptions for some basic actions done with objects.
  29 The strings are intended to be provided to the user e.g. as description for undo actions in the menu.
  30 The name of the object acted on and the type of action needs to be given as input parameter.
  31 */
  32
  33 class UNLESS_MERGELIBS(SVX_DLLPUBLIC) ActionDescriptionProvider
  34 {
  35 public:
  36     enum class ActionType
  37     {
  38         Insert
  39         , Delete
  40         , Move
  41         , Resize
  42         , Rotate
  43         , Format
  44         , MoveToTop
  45         , MoveToBottom
  46         , PosSize
  47     };
  48
  49 public:
  50     static OUString createDescription( ActionType eActionType
  51                         , std::u16string_view rObjectName );
  52 };
  53
  54 #endif
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */