include/vcl/commandinfoprovider.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 #ifndef INCLUDED_VCL_COMMANDINFOPROVIDER_HXX
  20 #define INCLUDED_VCL_COMMANDINFOPROVIDER_HXX
  21
  22 #include <vcl/dllapi.h>
  23 #include <vcl/image.hxx>
  24
  25 namespace com { namespace sun { namespace star { namespace frame { class XFrame; } } } }
  26
  27 namespace vcl { namespace CommandInfoProvider {
  28
  29     /** Return a label for the given command.
  30         @param rsCommandName
  31             The command name is expected to start with .uno:
  32         @param rsModuleName
  33             The current application module.
  34         @return
  35             The command label.
  36     */
  37     VCL_DLLPUBLIC OUString GetLabelForCommand (
  38         const OUString& rsCommandName,
  39         const OUString& rsModuleName);
  40
  41     VCL_DLLPUBLIC OUString GetMenuLabelForCommand (
  42         const OUString& rsCommandName,
  43         const OUString& rsModuleName);
  44
  45     VCL_DLLPUBLIC OUString GetPopupLabelForCommand (
  46         const OUString& rsCommandName,
  47         const OUString& rsModuleName);
  48
  49     /** Return a tooltip for the given command. Falls back to label if command has no tooltip.
  50         @param rsCommandName
  51             The command name is expected to start with .uno:
  52         @param rxFrame
  53             The frame is used to identify the module and document.
  54         @return
  55             The returned label contains the keyboard accelerator, if
  56             one is defined and bIncludeShortcut is true.
  57     */
  58     VCL_DLLPUBLIC OUString GetTooltipForCommand (
  59         const OUString& rsCommandName,
  60         const css::uno::Reference<css::frame::XFrame>& rxFrame);
  61
  62     /** Returns the shortcut for a command in human-readable form */
  63     VCL_DLLPUBLIC OUString GetCommandShortcut (const OUString& rCommandName,
  64                                                const css::uno::Reference<css::frame::XFrame>& rxFrame);
  65
  66     VCL_DLLPUBLIC OUString GetRealCommandForCommand( const OUString& rCommandName,
  67                                                      const OUString& rsModuleName );
  68
  69     VCL_DLLPUBLIC css::uno::Reference<css::graphic::XGraphic> GetXGraphicForCommand(
  70         const OUString& rsCommandName,
  71         const css::uno::Reference<css::frame::XFrame>& rxFrame,
  72         vcl::ImageType eImageType = vcl::ImageType::Small);
  73
  74     VCL_DLLPUBLIC Image GetImageForCommand(
  75         const OUString& rsCommandName,
  76         const css::uno::Reference<css::frame::XFrame>& rxFrame,
  77         vcl::ImageType eImageType = vcl::ImageType::Small);
  78
  79     VCL_DLLPUBLIC sal_Int32 GetPropertiesForCommand(
  80         const OUString& rsCommandName,
  81         const OUString& rsModuleName);
  82
  83     VCL_DLLPUBLIC bool IsRotated(const OUString& rsCommandName, const OUString& rsModuleName);
  84     VCL_DLLPUBLIC bool IsMirrored(const OUString& rsCommandName, const OUString& rsModuleName);
  85
  86     /** Returns whether the command is experimental. */
  87     VCL_DLLPUBLIC bool IsExperimental(
  88         const OUString& rsCommandName,
  89         const OUString& rModuleName);
  90
  91     VCL_DLLPUBLIC OUString const GetModuleIdentifier(const css::uno::Reference<css::frame::XFrame>& rxFrame);
  92 } }
  93
  94 #endif // INCLUDED_VCL_COMMANDINFOPROVIDER_HXX
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */