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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388 | /* -*- 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 .
*/
#include <strings.hrc>
#include <classes/fwkresid.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <osl/mutex.hxx>
#include <svtools/popupmenucontrollerbase.hxx>
#include <tools/urlobj.hxx>
#include <toolkit/awt/vclxmenu.hxx>
#include <unotools/historyoptions.hxx>
#include <vcl/menu.hxx>
#include <vcl/svapp.hxx>
using namespace css;
using namespace com::sun::star::uno;
using namespace com::sun::star::lang;
using namespace com::sun::star::frame;
using namespace com::sun::star::beans;
using namespace com::sun::star::util;
#define MAX_MENU_ITEMS 99
namespace {
static const char CMD_CLEAR_LIST[] = ".uno:ClearRecentFileList";
static const char CMD_OPEN_AS_TEMPLATE[] = ".uno:OpenTemplate";
static const char CMD_OPEN_REMOTE[] = ".uno:OpenRemote";
class RecentFilesMenuController : public svt::PopupMenuControllerBase
{
using svt::PopupMenuControllerBase::disposing;
public:
RecentFilesMenuController( const uno::Reference< uno::XComponentContext >& xContext,
const uno::Sequence< uno::Any >& args );
// XServiceInfo
virtual OUString SAL_CALL getImplementationName() override
{
return "com.sun.star.comp.framework.RecentFilesMenuController";
}
virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override
{
return cppu::supportsService(this, ServiceName);
}
virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override
{
return {"com.sun.star.frame.PopupMenuController"};
}
// XStatusListener
virtual void SAL_CALL statusChanged( const frame::FeatureStateEvent& Event ) override;
// XMenuListener
virtual void SAL_CALL itemSelected( const awt::MenuEvent& rEvent ) override;
virtual void SAL_CALL itemActivated( const awt::MenuEvent& rEvent ) override;
// XDispatchProvider
virtual uno::Reference< frame::XDispatch > SAL_CALL queryDispatch( const util::URL& aURL, const OUString& sTarget, sal_Int32 nFlags ) override;
// XDispatch
virtual void SAL_CALL dispatch( const util::URL& aURL, const uno::Sequence< beans::PropertyValue >& seqProperties ) override;
// XEventListener
virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
private:
virtual void impl_setPopupMenu() override;
void fillPopupMenu( css::uno::Reference< css::awt::XPopupMenu > const & rPopupMenu );
void executeEntry( sal_Int32 nIndex );
std::vector< OUString > m_aRecentFilesItems;
bool m_bDisabled : 1;
bool m_bShowToolbarEntries;
};
RecentFilesMenuController::RecentFilesMenuController( const uno::Reference< uno::XComponentContext >& xContext,
const uno::Sequence< uno::Any >& args ) :
svt::PopupMenuControllerBase( xContext ),
m_bDisabled( false ),
m_bShowToolbarEntries( false )
{
css::beans::PropertyValue aPropValue;
for ( uno::Any const & arg : args )
{
arg >>= aPropValue;
if ( aPropValue.Name == "InToolbar" )
{
aPropValue.Value >>= m_bShowToolbarEntries;
break;
}
}
}
// private function
void RecentFilesMenuController::fillPopupMenu( Reference< css::awt::XPopupMenu > const & rPopupMenu )
{
VCLXPopupMenu* pPopupMenu = static_cast<VCLXPopupMenu *>(comphelper::getUnoTunnelImplementation<VCLXMenu>( rPopupMenu ));
PopupMenu* pVCLPopupMenu = nullptr;
SolarMutexGuard aSolarMutexGuard;
resetPopupMenu( rPopupMenu );
if ( pPopupMenu )
pVCLPopupMenu = static_cast<PopupMenu *>(pPopupMenu->GetMenu());
if ( !pVCLPopupMenu )
return;
Sequence< Sequence< PropertyValue > > aHistoryList = SvtHistoryOptions().GetList( ePICKLIST );
int nPickListMenuItems = std::min<sal_Int32>( aHistoryList.getLength(), MAX_MENU_ITEMS );
m_aRecentFilesItems.clear();
if (( nPickListMenuItems > 0 ) && !m_bDisabled )
{
for ( int i = 0; i < nPickListMenuItems; i++ )
{
const Sequence< PropertyValue >& rPickListEntry = aHistoryList[i];
OUString aURL;
for ( PropertyValue const & prop : rPickListEntry )
{
if ( prop.Name == HISTORY_PROPERTYNAME_URL )
{<--- Consider using std::find_if algorithm instead of a raw loop.
prop.Value >>= aURL;
break;
}
}
m_aRecentFilesItems.push_back( aURL );
}
}
if ( !m_aRecentFilesItems.empty() )
{
const sal_uInt32 nCount = m_aRecentFilesItems.size();
for ( sal_uInt32 i = 0; i < nCount; i++ )
{
OUStringBuffer aMenuShortCut;
if ( i <= 9 )
{
if ( i == 9 )
aMenuShortCut.append( "1~0. " );
else
{
aMenuShortCut.append( "~N. " );
aMenuShortCut[ 1 ] = sal_Unicode( i + '1' );
}
}
else
{
aMenuShortCut.append( sal_Int32( i + 1 ) );
aMenuShortCut.append( ". " );
}
OUString aURLString = "vnd.sun.star.popup:RecentFileList?entry=" + OUString::number(i);
// Abbreviate URL
OUString aMenuTitle;
INetURLObject aURL( m_aRecentFilesItems[i] );
OUString aTipHelpText( aURL.getFSysPath( FSysStyle::Detect ) );
if ( aURL.GetProtocol() == INetProtocol::File )
{
// Do handle file URL differently: don't show the protocol, just the file name
aMenuTitle = aURL.GetLastName(INetURLObject::DecodeMechanism::WithCharset);
}
else
{
// In all other URLs show the protocol name before the file name
aMenuTitle = INetURLObject::GetSchemeName(aURL.GetProtocol()) + ": " + aURL.getName();
}
aMenuShortCut.append( aMenuTitle );
pVCLPopupMenu->InsertItem( sal_uInt16( i+1 ), aMenuShortCut.makeStringAndClear() );
pVCLPopupMenu->SetTipHelpText( sal_uInt16( i+1 ), aTipHelpText );
pVCLPopupMenu->SetItemCommand( sal_uInt16( i+1 ), aURLString );
}
pVCLPopupMenu->InsertSeparator();
// Clear List menu entry
pVCLPopupMenu->InsertItem( sal_uInt16( nCount + 1 ),
FwkResId(STR_CLEAR_RECENT_FILES) );
pVCLPopupMenu->SetItemCommand( sal_uInt16( nCount + 1 ),
CMD_CLEAR_LIST );
pVCLPopupMenu->SetHelpText( sal_uInt16( nCount + 1 ),
FwkResId(STR_CLEAR_RECENT_FILES_HELP) );
// Open remote menu entry
if ( m_bShowToolbarEntries )
{
pVCLPopupMenu->InsertSeparator();
pVCLPopupMenu->InsertItem( CMD_OPEN_AS_TEMPLATE, m_xFrame );
pVCLPopupMenu->InsertItem( CMD_OPEN_REMOTE, m_xFrame );
}
}
else
{
if ( m_bShowToolbarEntries )
{
pVCLPopupMenu->InsertItem( CMD_OPEN_AS_TEMPLATE, m_xFrame );
pVCLPopupMenu->InsertItem( CMD_OPEN_REMOTE, m_xFrame );
}
else
{
// No recent documents => insert "no document" string
pVCLPopupMenu->InsertItem( 1, FwkResId(STR_NODOCUMENT) );
// Do not disable it, otherwise the Toolbar controller and MenuButton
// will display SV_RESID_STRING_NOSELECTIONPOSSIBLE instead of STR_NODOCUMENT
pVCLPopupMenu->SetItemBits( 1, pVCLPopupMenu->GetItemBits( 1 ) | MenuItemBits::NOSELECT );
}
}
}
void RecentFilesMenuController::executeEntry( sal_Int32 nIndex )
{
if (( nIndex < 0 ) ||
( nIndex >= sal::static_int_cast<sal_Int32>( m_aRecentFilesItems.size() )))
return;
Sequence< PropertyValue > aArgsList(3);
aArgsList[0].Name = "Referer";
aArgsList[0].Value <<= OUString( "private:user" );
// documents in the picklist will never be opened as templates
aArgsList[1].Name = "AsTemplate";
aArgsList[1].Value <<= false;
// Type detection needs to know which app we are opening it from.
aArgsList[2].Name = "DocumentService";
aArgsList[2].Value <<= m_aModuleName;
dispatchCommand( m_aRecentFilesItems[ nIndex ], aArgsList, "_default" );
}
// XEventListener
void SAL_CALL RecentFilesMenuController::disposing( const EventObject& )
{
Reference< css::awt::XMenuListener > xHolder(static_cast<OWeakObject *>(this), UNO_QUERY );
osl::MutexGuard aLock( m_aMutex );
m_xFrame.clear();
m_xDispatch.clear();
if ( m_xPopupMenu.is() )
m_xPopupMenu->removeMenuListener( Reference< css::awt::XMenuListener >(static_cast<OWeakObject *>(this), UNO_QUERY ));
m_xPopupMenu.clear();
}
// XStatusListener
void SAL_CALL RecentFilesMenuController::statusChanged( const FeatureStateEvent& Event )
{
osl::MutexGuard aLock( m_aMutex );
m_bDisabled = !Event.IsEnabled;
}
void SAL_CALL RecentFilesMenuController::itemSelected( const css::awt::MenuEvent& rEvent )
{
Reference< css::awt::XPopupMenu > xPopupMenu;
{
osl::MutexGuard aLock(m_aMutex);
xPopupMenu = m_xPopupMenu;
}
if ( !xPopupMenu.is() )
return;
const OUString aCommand( xPopupMenu->getCommand( rEvent.MenuId ) );
if ( aCommand == CMD_CLEAR_LIST )
{
SvtHistoryOptions().Clear( ePICKLIST );
dispatchCommand(
"vnd.org.libreoffice.recentdocs:ClearRecentFileList",
css::uno::Sequence< css::beans::PropertyValue >() );
}
else if ( aCommand == CMD_OPEN_REMOTE )
{
Sequence< PropertyValue > aArgsList( 0 );
dispatchCommand( CMD_OPEN_REMOTE, aArgsList );
}
else if ( aCommand == CMD_OPEN_AS_TEMPLATE )
{
Sequence< PropertyValue > aArgsList( 0 );
dispatchCommand( CMD_OPEN_AS_TEMPLATE, aArgsList );
}
else
executeEntry( rEvent.MenuId-1 );
}
void SAL_CALL RecentFilesMenuController::itemActivated( const css::awt::MenuEvent& )
{
osl::MutexGuard aLock( m_aMutex );
impl_setPopupMenu();
}
// XPopupMenuController
void RecentFilesMenuController::impl_setPopupMenu()
{
if ( m_xPopupMenu.is() )
fillPopupMenu( m_xPopupMenu );
}
// XDispatchProvider
Reference< XDispatch > SAL_CALL RecentFilesMenuController::queryDispatch(
const URL& aURL,
const OUString& /*sTarget*/,
sal_Int32 /*nFlags*/ )
{
osl::MutexGuard aLock( m_aMutex );
throwIfDisposed();
if ( aURL.Complete.startsWith( m_aBaseURL ) )
return Reference< XDispatch >( static_cast< OWeakObject* >( this ), UNO_QUERY );
else
return Reference< XDispatch >();
}
// XDispatch
void SAL_CALL RecentFilesMenuController::dispatch(
const URL& aURL,
const Sequence< PropertyValue >& /*seqProperties*/ )
{
osl::MutexGuard aLock( m_aMutex );
throwIfDisposed();
if ( !aURL.Complete.startsWith( m_aBaseURL ) )
return;
// Parse URL to retrieve entry argument and its value
sal_Int32 nQueryPart = aURL.Complete.indexOf( '?', m_aBaseURL.getLength() );
if ( nQueryPart <= 0 )
return;
const OUString aEntryArgStr( "entry=" );
sal_Int32 nEntryArg = aURL.Complete.indexOf( aEntryArgStr, nQueryPart );
sal_Int32 nEntryPos = nEntryArg + aEntryArgStr.getLength();
if (( nEntryArg <= 0 ) || ( nEntryPos >= aURL.Complete.getLength() ))
return;
sal_Int32 nAddArgs = aURL.Complete.indexOf( '&', nEntryPos );
OUString aEntryArg;
if ( nAddArgs < 0 )
aEntryArg = aURL.Complete.copy( nEntryPos );
else
aEntryArg = aURL.Complete.copy( nEntryPos, nAddArgs-nEntryPos );
sal_Int32 nEntry = aEntryArg.toInt32();
executeEntry( nEntry );
}
}
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
com_sun_star_comp_framework_RecentFilesMenuController_get_implementation(<--- The function 'com_sun_star_comp_framework_RecentFilesMenuController_get_implementation' is never used.
css::uno::XComponentContext *context,
css::uno::Sequence<css::uno::Any> const &args)
{
return cppu::acquire(new RecentFilesMenuController(context, args));
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|