1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SVTOOLS_CONTEXTMENUHELPER_HXX
#define INCLUDED_SVTOOLS_CONTEXTMENUHELPER_HXX
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/awt/XPopupMenu.hpp>
#include <com/sun/star/util/XURLTransformer.hpp>
#include <com/sun/star/ui/XImageManager.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <rtl/ustring.hxx>
#include <cppuhelper/weak.hxx>
#include <cppuhelper/weakref.hxx>
#include <vcl/menu.hxx>
#include <svtools/svtdllapi.h>
namespace svt
{
/**
Context menu helper class.
Fills images and labels for a provided popup menu or
com.sun.star.awt.XPopupMenu.
PRECONDITION:
All commands must be set via SetItemCommand and are part
of the configuration files
(see org.openoffice.Office.UI.[Module]Commands.xcu)
*/
struct ExecuteInfo;
class SVT_DLLPUBLIC ContextMenuHelper
{
public:
// create context menu helper
// ARGS: xFrame = frame defines the context of the context menu
// bAutoRefresh = specifies that the context will be constant or not
ContextMenuHelper( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& xFrame, bool bAutoRefresh=true );
~ContextMenuHelper();
// methods to complete a popup menu (set images, labels, enable/disable states)
// ATTENTION: The item ID's must be unique for the whole popup (inclusive the sub menus!)
void completeAndExecute( const Point& aPos, PopupMenu& aPopupMenu );
void completeAndExecute( const Point& aPos, const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XPopupMenu >& xPopupMenu );
private:
// asynchronous link to prevent destruction while on stack
DECL_STATIC_LINK( ContextMenuHelper, ExecuteHdl_Impl, ExecuteInfo* );
ContextMenuHelper( const ContextMenuHelper& ) SAL_DELETED_FUNCTION;
const ContextMenuHelper& operator=( const ContextMenuHelper& ) SAL_DELETED_FUNCTION;
// show context menu and dispatch command automatically
void executePopupMenu( const Point& aPos, PopupMenu* pMenu );
// fill image and label for every menu item on the provided menu
void completeMenuProperties( Menu* pMenu );
// dispatch provided command
bool dispatchCommand( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& xFrame, const OUString& aCommandURL );
// methods to retrieve a single command URL dependent value from a
// ui configuration manager
Image getImageFromCommandURL( const OUString& aCmdURL ) const;
OUString getLabelFromCommandURL( const OUString& aCmdURL ) const;
// creates an association between current module/controller bound to the
// provided frame and their ui configuration managers.
bool associateUIConfigurationManagers();
// resets associations to create associations again on-demand.
// Useful for implementations which recycle frames. Normal
// implementations can profit from caching and should set
// auto refresh on ctor to false (default).
void resetAssociations()
{
if ( m_bAutoRefresh )
m_bUICfgMgrAssociated = false;
}
::com::sun::star::uno::WeakReference< ::com::sun::star::frame::XFrame > m_xWeakFrame;
OUString m_aSelf;
::com::sun::star::uno::Reference< ::com::sun::star::util::XURLTransformer > m_xURLTransformer;
::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > m_aDefaultArgs;
::com::sun::star::uno::Reference< ::com::sun::star::ui::XImageManager > m_xDocImageMgr;
::com::sun::star::uno::Reference< ::com::sun::star::ui::XImageManager > m_xModuleImageMgr;
::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess > m_xUICommandLabels;
bool m_bAutoRefresh;
bool m_bUICfgMgrAssociated;
};
} // namespace svt
#endif // INCLUDED_SVTOOLS_CONTEXTMENUHELPER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
