svx/inc/ActionDescriptionProvider.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ActionDescriptionProvider.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _SVX_ACTIONDESCRIPTIONPROVIDER_HXX
  32 #define _SVX_ACTIONDESCRIPTIONPROVIDER_HXX
  33
  34 #include "svx/svxdllapi.h"
  35
  36 // header for class OUString
  37 #include <rtl/ustring.hxx>
  38
  39 //-----------------------------------------------------------------------------
  40 /** This class provides localized descriptions for some basic actions done with objects.
  41 The strings are intended to be provided to the user e.g. as description for undo actions in the menu.
  42 The name of the object acted on and the type of action needs to be given as input parameter.
  43 */
  44
  45 class SVX_DLLPUBLIC ActionDescriptionProvider
  46 {
  47 public:
  48     enum ActionType
  49     {
  50         INSERT
  51         , DELETE
  52         , CUT
  53         , MOVE
  54         , RESIZE
  55         , ROTATE
  56         , TRANSFORM
  57         , FORMAT
  58         , MOVE_TOTOP
  59         , MOVE_TOBOTTOM
  60         , POS_SIZE
  61     };
  62
  63 public:
  64     static ::rtl::OUString createDescription( ActionType eActionType
  65                         , const ::rtl::OUString& rObjectName );
  66 };
  67
  68 #endif