LibreOffice Module vcl (master)  1
commandinfoprovider.hxx
Go to the documentation of this file.
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 #include <vcl/keycod.hxx>
25 
26 namespace com::sun::star::frame { class XFrame; }
27 namespace com::sun::star::beans { struct PropertyValue; }
28 
29 namespace vcl::CommandInfoProvider {
30 
39  VCL_DLLPUBLIC css::uno::Sequence<css::beans::PropertyValue> GetCommandProperties(const OUString& rsCommandName, const OUString& rsModuleName);
40 
47  VCL_DLLPUBLIC OUString GetLabelForCommand(const css::uno::Sequence<css::beans::PropertyValue>& rProperties);
48 
49  VCL_DLLPUBLIC OUString GetMenuLabelForCommand(const css::uno::Sequence<css::beans::PropertyValue>& rProperties);
50 
51  VCL_DLLPUBLIC OUString GetPopupLabelForCommand(const css::uno::Sequence<css::beans::PropertyValue>& rProperties);
52 
53  VCL_DLLPUBLIC OUString GetTooltipLabelForCommand(const css::uno::Sequence<css::beans::PropertyValue>& rProperties);
54 
67  const OUString& rsCommandName,
68  const css::uno::Sequence<css::beans::PropertyValue>& rProperties,
69  const css::uno::Reference<css::frame::XFrame>& rxFrame);
70 
72  VCL_DLLPUBLIC OUString GetCommandShortcut (const OUString& rCommandName,
73  const css::uno::Reference<css::frame::XFrame>& rxFrame);
74 
75  VCL_DLLPUBLIC KeyCode GetCommandKeyCodeShortcut (const OUString& rCommandName,
76  const css::uno::Reference<css::frame::XFrame>& rxFrame);
77 
78  VCL_DLLPUBLIC OUString GetRealCommandForCommand(const css::uno::Sequence<css::beans::PropertyValue>& rProperties);
79 
80  VCL_DLLPUBLIC css::uno::Reference<css::graphic::XGraphic> GetXGraphicForCommand(
81  const OUString& rsCommandName,
82  const css::uno::Reference<css::frame::XFrame>& rxFrame,
84 
86  const OUString& rsCommandName,
87  const css::uno::Reference<css::frame::XFrame>& rxFrame,
89 
91  const OUString& rsCommandName,
92  const OUString& rsModuleName);
93 
94  VCL_DLLPUBLIC bool IsRotated(const OUString& rsCommandName, const OUString& rsModuleName);
95  VCL_DLLPUBLIC bool IsMirrored(const OUString& rsCommandName, const OUString& rsModuleName);
96 
99  const OUString& rsCommandName,
100  const OUString& rModuleName);
101 
102  VCL_DLLPUBLIC OUString GetModuleIdentifier(const css::uno::Reference<css::frame::XFrame>& rxFrame);
103 }
104 
105 #endif // INCLUDED_VCL_COMMANDINFOPROVIDER_HXX
106 
107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
OUString GetTooltipLabelForCommand(const css::uno::Sequence< css::beans::PropertyValue > &rProperties)
bool IsMirrored(const OUString &rsCommandName, const OUString &rsModuleName)
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
OUString GetLabelForCommand(const css::uno::Sequence< css::beans::PropertyValue > &rProperties)
Return a label for the given command.
OUString GetMenuLabelForCommand(const css::uno::Sequence< css::beans::PropertyValue > &rProperties)
vcl::KeyCode GetCommandKeyCodeShortcut(const OUString &rsCommandName, const Reference< frame::XFrame > &rxFrame)
OUString GetRealCommandForCommand(const css::uno::Sequence< css::beans::PropertyValue > &rProperties)
bool IsExperimental(const OUString &rsCommandName, const OUString &rModuleName)
Returns whether the command is experimental.
OUString GetPopupLabelForCommand(const css::uno::Sequence< css::beans::PropertyValue > &rProperties)
Image GetImageForCommand(const OUString &rsCommandName, const Reference< frame::XFrame > &rxFrame, vcl::ImageType eImageType)
OUString GetModuleIdentifier(const Reference< frame::XFrame > &rxFrame)
ImageType
Definition: vclenum.hxx:322
Reference< graphic::XGraphic > GetXGraphicForCommand(const OUString &rsCommandName, const Reference< frame::XFrame > &rxFrame, vcl::ImageType eImageType)
Sequence< beans::PropertyValue > GetCommandProperties(const OUString &rsCommandName, const OUString &rsModuleName)
Return a label for the given command.
sal_Int32 GetPropertiesForCommand(const OUString &rsCommandName, const OUString &rsModuleName)
Definition: image.hxx:40
OUString GetCommandShortcut(const OUString &rsCommandName, const Reference< frame::XFrame > &rxFrame)
bool IsRotated(const OUString &rsCommandName, const OUString &rsModuleName)
OUString GetTooltipForCommand(const OUString &rsCommandName, const css::uno::Sequence< css::beans::PropertyValue > &rProperties, const Reference< frame::XFrame > &rxFrame)