1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef _SVX_ACTIONDESCRIPTIONPROVIDER_HXX
25 #define _SVX_ACTIONDESCRIPTIONPROVIDER_HXX
26 
27 #include "svx/svxdllapi.h"
28 
29 // header for class OUString
30 #include <rtl/ustring.hxx>
31 
32 //-----------------------------------------------------------------------------
33 /** This class provides localized descriptions for some basic actions done with objects.
34 The strings are intended to be provided to the user e.g. as description for undo actions in the menu.
35 The name of the object acted on and the type of action needs to be given as input parameter.
36 */
37 
38 class SVX_DLLPUBLIC ActionDescriptionProvider
39 {
40 public:
41     enum ActionType
42     {
43         INSERT
44         , DELETE
45         , CUT
46         , MOVE
47         , RESIZE
48         , ROTATE
49         , TRANSFORM
50         , FORMAT
51         , MOVE_TOTOP
52         , MOVE_TOBOTTOM
53         , POS_SIZE
54     };
55 
56 public:
57     static ::rtl::OUString createDescription( ActionType eActionType
58                         , const ::rtl::OUString& rObjectName );
59 };
60 
61 #endif
62