blob: df6dadcdc1fd8f8341efbec978ebe80ceb7eda3f (
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
112
113
114
115
116
117
118
119
120
|
/* -*- 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 __com_sun_star_ui_dialogs_FilePicker_idl__
#define __com_sun_star_ui_dialogs_FilePicker_idl__
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/lang/XInitialization.idl>
#include <com/sun/star/util/XCancellable.idl>
module com { module sun { module star { module ui { module dialogs {
/** A FilePicker.
It is <strong>NOT</strong> recommended to cache a reference to a file
picker instance. Due to restrictions by the underlying system there can
be specific limitations possible. To overcome these problems it's
recommended to create a new instance on demand.
@see XFilePicker
*/
published interface XFilePicker;
published interface XFilePickerNotifier;
published interface XFilePickerControlAccess;
published interface XFilterManager;
published interface XFilePreview;
published interface XFilterGroupManager;
published service FilePicker
{
/** Allows to associate a help URL with the file picker instance.
*/
[optional, property] string HelpURL;
/** Provides access to the basic FilePicker functionality.
*/
interface XFilePicker;
/** Provides the ability to request notifications about changes.
*/
interface XFilePickerNotifier;
/** Provides the ability to add different filter, query for the current
filters and set a current filter
*/
interface XFilterManager;
/** Provides the ability to show a preview of a selected file
*/
[optional] interface XFilePreview;
/** Provides the ability manage additional controls (checkboxes, listboxes etc.)
offered by an extended FilePicker, these controls extend the subset of
common controls that a FilePicker usually supports.
@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
@deprecated
*/
[optional] interface XFilePickerControlAccess;
/** An interface which allows manipulation of groups of filters
*/
[optional] interface XFilterGroupManager;
/** Provides the ability to choose between different custom templates that
do extend the subset of common controls a FilePicker usually supports.
Implementers may omit this interface if the FileOpen
dialog doesn't support custom templates. In this case a createInstance
will create an ordinary FileOpen dialog with only the common FilePicker
elements.
The client has to provide one of the specified constants in
TemplateDescription.
<br/><br/>
<p><strong>Notes for the implementation of a FileSave dialog:</strong>
The implementation of a FileSave dialog should automatically check
for existence of a file and issue a warning if a file with the same
name already exist.</p>
@see com::sun::star::ui::dialogs::TemplateDescription
*/
[optional] interface com::sun::star::lang::XInitialization;
/** For canceling a running dialog instance.
<p>This may be useful for automatic test tools for instance.</p>
*/
[optional] interface com::sun::star::util::XCancellable;
/** For shutdown and listener support.
*/
interface com::sun::star::lang::XComponent;
};
}; }; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
