LibreOffice Module unotools (master)
1
include
unotools
dynamicmenuoptions.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_UNOTOOLS_DYNAMICMENUOPTIONS_HXX
20
#define INCLUDED_UNOTOOLS_DYNAMICMENUOPTIONS_HXX
21
22
#include <
unotools/unotoolsdllapi.h
>
23
#include <rtl/ustring.hxx>
24
#include <vector>
25
26
/*-****************************************************************************************************************
27
@descr struct to hold information about one menu entry.
28
****************************************************************************************************************-*/
29
struct
SvtDynMenuEntry
30
{
31
OUString
sURL
;
32
OUString
sTitle
;
33
OUString
sImageIdentifier
;
34
OUString
sTargetName
;
35
};
36
37
/*-************************************************************************************************************
38
@descr You can use these enum values to specify right menu if you call our interface methods.
39
*/
/*-*************************************************************************************************************/
40
enum class
EDynamicMenuType
41
{
42
NewMenu
= 0,
43
WizardMenu
= 1
44
};
45
46
47
/*-************************************************************************************************************
48
@short collect information about dynamic menus
49
@descr Make it possible to configure dynamic menu structures of menus like "new" or "wizard".
50
@devstatus ready to use
51
*/
/*-*************************************************************************************************************/
52
53
namespace
SvtDynamicMenuOptions
54
{
55
56
/*-****************************************************************************************************
57
@short return complete specified list
58
@descr Call it to get all entries of an dynamic menu.
59
We return a list of all nodes with its names and properties.
60
@param "eMenu" select right menu.
61
@return A list of menu items is returned.
62
63
@onerror We return an empty list.
64
*/
/*-*****************************************************************************************************/
65
66
UNOTOOLS_DLLPUBLIC
std::vector< SvtDynMenuEntry >
GetMenu
(
EDynamicMenuType
eMenu );
67
68
69
};
// namespace SvtDynamicMenuOptions
70
71
#endif
// INCLUDED_UNOTOOLS_DYNAMICMENUOPTIONS_HXX
72
73
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
EDynamicMenuType
EDynamicMenuType
Definition:
dynamicmenuoptions.hxx:41
EDynamicMenuType::NewMenu
@ NewMenu
EDynamicMenuType::WizardMenu
@ WizardMenu
SvtDynamicMenuOptions
Definition:
dynamicmenuoptions.cxx:113
SvtDynamicMenuOptions::GetMenu
std::vector< SvtDynMenuEntry > GetMenu(EDynamicMenuType eMenu)
Definition:
dynamicmenuoptions.cxx:119
SvtDynMenuEntry
Definition:
dynamicmenuoptions.hxx:30
SvtDynMenuEntry::sTitle
OUString sTitle
Definition:
dynamicmenuoptions.hxx:32
SvtDynMenuEntry::sURL
OUString sURL
Definition:
dynamicmenuoptions.hxx:31
SvtDynMenuEntry::sImageIdentifier
OUString sImageIdentifier
Definition:
dynamicmenuoptions.hxx:33
SvtDynMenuEntry::sTargetName
OUString sTargetName
Definition:
dynamicmenuoptions.hxx:34
unotoolsdllapi.h
UNOTOOLS_DLLPUBLIC
#define UNOTOOLS_DLLPUBLIC
Definition:
unotoolsdllapi.h:28
Generated on Sun Jul 30 2023 04:29:23 for LibreOffice Module unotools (master) by
1.9.3