blob: 51601db30d9940d16530b62f4b51ebbf9e0df47d (
plain)
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
|
/* -*- 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_UNOTOOLS_HISTORYOPTIONS_HXX
#define INCLUDED_UNOTOOLS_HISTORYOPTIONS_HXX
#include <boost/optional.hpp>
#include <unotools/unotoolsdllapi.h>
#include <sal/types.h>
#include <osl/mutex.hxx>
#include <com/sun/star/uno/Sequence.h>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <rtl/ustring.hxx>
#include <unotools/options.hxx>
#include <memory>
// The method GetList() returns a list of property values.
// Use follow defines to separate values by names.
#define HISTORY_PROPERTYNAME_URL "URL"
#define HISTORY_PROPERTYNAME_FILTER "Filter"
#define HISTORY_PROPERTYNAME_TITLE "Title"
#define HISTORY_PROPERTYNAME_PASSWORD "Password"
#define HISTORY_PROPERTYNAME_THUMBNAIL "Thumbnail"
/// You can use these enum values to specify right history if you call our interface methods.
enum EHistoryType
{
ePICKLIST = 0,
eHELPBOOKMARKS = 1
};
class SvtHistoryOptions_Impl;
/** Collect information about history features.
Interface methods to get and set value of config key "org.openoffice.Office.Common/History/..."
key "PickList": The last used documents displayed in the file menu.
key "History": The last opened documents general.
*/
class SAL_WARN_UNUSED UNOTOOLS_DLLPUBLIC SvtHistoryOptions : public utl::detail::Options
{
public:
SvtHistoryOptions();
virtual ~SvtHistoryOptions();
/** Get max size of specified history.
Call this methods to get information about max. size of specified list.
If a new one is add to it the oldest one is deleted automatically.
@param eHistory select right history.
@return Current max size of specified list.
*/
sal_uInt32 GetSize(EHistoryType eHistory) const;
/** Clear complete specified list.
@param eHistory select right history.
*/
void Clear(EHistoryType eHistory);
/** Return the complete specified history list.
@param eHistory select right history.
@return A list of history items is returned.
*/
css::uno::Sequence< css::uno::Sequence< css::beans::PropertyValue > > GetList(EHistoryType eHistory) const;
/** Append a new item to the specified list.
The oldest entry is deleted automatically when the size reaches the maximum.
@param eHistory select right history.
@param sURL URL to save in history
@param sFilter filter name to save in history
@param sTitle document title to save in history
@param sPassword password to save in history
*/
void AppendItem(EHistoryType eHistory,
const OUString& sURL, const OUString& sFilter, const OUString& sTitle,
const OUString& sPassword, const boost::optional<OUString>& sThumbnail);
/** Delete item from the specified list.
*/
void DeleteItem(EHistoryType eHistory, const OUString& sURL);
private:
std::shared_ptr<SvtHistoryOptions_Impl> m_pImpl;
};
#endif // INCLUDED_UNOTOOLS_HISTORYOPTIONS_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
