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