Line data Source code
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_SFX2_FILEDLGHELPER_HXX
20 : #define INCLUDED_SFX2_FILEDLGHELPER_HXX
21 :
22 : #include <sal/config.h>
23 : #include <sfx2/dllapi.h>
24 : #include <sal/types.h>
25 : #include <com/sun/star/uno/Reference.hxx>
26 : #include <com/sun/star/uno/Sequence.hxx>
27 : #include <rtl/ustring.hxx>
28 : #include <tools/errcode.hxx>
29 : #include <vcl/dialog.hxx>
30 : #include <vcl/edit.hxx>
31 : #include <vcl/button.hxx>
32 : #include <vcl/graph.hxx>
33 : #include <sfx2/sfxuno.hxx>
34 : #include <sfx2/docfilt.hxx>
35 :
36 : namespace com
37 : {
38 : namespace sun
39 : {
40 : namespace star
41 : {
42 : namespace ui
43 : {
44 : namespace dialogs
45 : {
46 : class XFilePicker;
47 : class XFilePickerListener;
48 : struct FilePickerEvent;
49 : struct DialogClosedEvent;
50 : }
51 : }
52 : }
53 : }
54 : }
55 :
56 : class SfxItemSet;
57 : namespace vcl { class Window; }
58 :
59 : // the SFXWB constants are for the nFlags parameter of the constructor
60 : #define SFXWB_INSERT 0x04000000L // turn Open into Insert dialog
61 : #define SFXWB_EXPORT 0x40000000L // turn Save into Export dialog
62 : #define SFXWB_SAVEACOPY 0x00400000L // turn Save into Save a Copy dialog
63 : #define SFXWB_MULTISELECTION 0x20000000L
64 : #define SFXWB_GRAPHIC 0x00800000L // register graphic formats
65 :
66 : #define FILEDIALOG_FILTER_ALL "*.*"
67 :
68 : #define FILE_OPEN_SERVICE_NAME_OOO "com.sun.star.ui.dialogs.OfficeFilePicker"
69 :
70 : namespace sfx2 {
71 :
72 : class FileDialogHelper_Impl;
73 :
74 : class SFX2_DLLPUBLIC FileDialogHelper
75 : {
76 : public:
77 : enum Context // context where the FileDialogHelper is used
78 : {
79 : UNKNOWN_CONTEXT, // unknown context
80 : SW_INSERT_GRAPHIC, // insert graphic in writer
81 : SW_INSERT_SOUND, // insert sound in writer
82 : SW_INSERT_VIDEO, // insert video in writer
83 : SC_INSERT_GRAPHIC, // insert graphic in calc
84 : SC_INSERT_SOUND, // insert sound in calc
85 : SC_INSERT_VIDEO, // insert video in calc
86 : SD_INSERT_GRAPHIC, // insert graphic in draw
87 : SD_INSERT_SOUND, // insert sound in draw
88 : SD_INSERT_VIDEO, // insert video in draw
89 : SD_EXPORT, // export in draw
90 : SI_EXPORT, // export in impress
91 : SW_EXPORT // export in writer
92 : };
93 :
94 : private:
95 : Link<> m_aDialogClosedLink;
96 : ErrCode m_nError;
97 :
98 : ::com::sun::star::uno::Reference < ::com::sun::star::ui::dialogs::XFilePickerListener > mxImp;
99 : FileDialogHelper_Impl *mpImp;
100 :
101 :
102 : public:
103 : FileDialogHelper( sal_Int16 nDialogType,
104 : sal_Int64 nFlags,
105 : vcl::Window* _pPreferredParent = NULL );
106 :
107 : FileDialogHelper( sal_Int16 nDialogType,
108 : sal_Int64 nFlags,
109 : const OUString& rFactory,
110 : SfxFilterFlags nMust = SfxFilterFlags::NONE,
111 : SfxFilterFlags nDont = SfxFilterFlags::NONE );
112 :
113 : FileDialogHelper( sal_Int16 nDialogType,
114 : sal_Int64 nFlags,
115 : const OUString& rFactory,
116 : sal_Int16 nDialog,
117 : SfxFilterFlags nMust,
118 : SfxFilterFlags nDont,
119 : const OUString& rStandardDir,
120 : const ::com::sun::star::uno::Sequence< OUString >& rBlackList);
121 :
122 : FileDialogHelper( sal_Int16 nDialogType,
123 : sal_Int64 nFlags,
124 : const OUString& aFilterUIName,
125 : const OUString& aExtName,
126 : const OUString& rStandardDir,
127 : const ::com::sun::star::uno::Sequence< OUString >& rBlackList,
128 : vcl::Window* _pPreferredParent = NULL );
129 :
130 :
131 : virtual ~FileDialogHelper();
132 :
133 : ErrCode Execute();
134 : void StartExecuteModal( const Link<>& rEndDialogHdl );
135 0 : inline ErrCode GetError() const { return m_nError; }
136 : sal_Int16 GetDialogType() const;
137 : bool IsPasswordEnabled() const;
138 : OUString GetRealFilter() const;
139 :
140 : void SetTitle( const OUString& rNewTitle );
141 : OUString GetPath() const;
142 :
143 : /** @deprected: Don't use this method to retrieve the selected files
144 : There are file picker which can provide multiple selected file which belong
145 : to different folders. As this method always provides the root folder for all selected
146 : files this cannot work.
147 : */
148 : ::com::sun::star::uno::Sequence< OUString > GetMPath() const;
149 :
150 : /** Provides the selected files with full path information */
151 : ::com::sun::star::uno::Sequence< OUString > GetSelectedFiles() const;
152 :
153 : void AddFilter( const OUString& rFilterName, const OUString& rExtension );
154 : void SetCurrentFilter( const OUString& rFilter );
155 :
156 : /** sets an initial display directory/file name
157 :
158 : @deprecated
159 : don't use this method. It contains a lot of magic in determining whether the
160 : last segment of the given path/URL denotes a file name or a folder, and by
161 : definition, it cannot succeed with this magic *all* the time - there will
162 : always be scenarios where it fails.
163 :
164 : Use SetDisplayFolder and SetFileName.
165 : */
166 : void SetDisplayDirectory( const OUString& rPath );
167 :
168 : /** sets a new folder whose content is to be displayed in the file picker
169 :
170 : @param _rURL
171 : specifies the URL of the folder whose content is to be displayed.<br/>
172 : If the URL doesn't denote a valid (existent and accessible) folder, the
173 : request is silently dropped.
174 : @throws ::com::sun::star::uno::RuntimeException
175 : if the invocation of any of the file picker or UCB methods throws a RuntimeException.
176 : */
177 : void SetDisplayFolder( const OUString& _rURL );
178 :
179 : /** sets an initial file name to display
180 :
181 : This method is usually used in "save-as" contexts, where the application should
182 : suggest an initial name for the file to save.
183 :
184 : Calling this method is nearly equivalent to calling <code>GetFilePicker().setDefaultName( _rFileName )</code>,
185 : with the following differences:
186 : <ul><li>The FileDialogHelper remembers the given file name, and upon execution,
187 : strips its extension if the dialog is set up for "automatic file name extension".</li>
188 : <li>Exceptions thrown from the <code>XFilePicker</code> are caught and silenced.</li>
189 : </ul>
190 : */
191 : void SetFileName( const OUString& _rFileName );
192 :
193 : OUString GetCurrentFilter() const;
194 : OUString GetDisplayDirectory() const;
195 : ErrCode GetGraphic( Graphic& rGraphic ) const;
196 :
197 : ::com::sun::star::uno::Reference < ::com::sun::star::ui::dialogs::XFilePicker > GetFilePicker() const;
198 :
199 : // XFilePickerListener methods
200 : void SAL_CALL FileSelectionChanged( const ::com::sun::star::ui::dialogs::FilePickerEvent& aEvent );
201 : void SAL_CALL DirectoryChanged( const ::com::sun::star::ui::dialogs::FilePickerEvent& aEvent );
202 : virtual void SAL_CALL ControlStateChanged( const ::com::sun::star::ui::dialogs::FilePickerEvent& aEvent );
203 : void SAL_CALL DialogSizeChanged();
204 : static OUString SAL_CALL HelpRequested( const ::com::sun::star::ui::dialogs::FilePickerEvent& aEvent );
205 :
206 : // XDialogClosedListener methods
207 : void SAL_CALL DialogClosed( const ::com::sun::star::ui::dialogs::DialogClosedEvent& _rEvent );
208 :
209 : /** sets help ids for the controls in the dialog
210 : @param _pControlId
211 : Pointer to a 0-terminated array of control ids. They must be recruited from the
212 : CommonFilePickerElementIds and ExtendedFilePickerElementIds values.
213 : @param _pHelpId
214 : Pointer to an array of help ids. For each element in _pControlId, there must be
215 : a corresponding element herein.
216 : */
217 : void SetControlHelpIds( const sal_Int16* _pControlId, const char** _pHelpId );
218 : void CreateMatcher( const OUString& rName );
219 :
220 : /** sets the context of the dialog and trigger necessary actions e.g. loading config, setting help id
221 : @param _eNewContext
222 : New context for the dialog.
223 : */
224 : void SetContext( Context _eNewContext );
225 :
226 : DECL_LINK( ExecuteSystemFilePicker, void* );
227 :
228 : ErrCode Execute( std::vector<OUString>& rpURLList,
229 : SfxItemSet *& rpSet,
230 : OUString& rFilter,
231 : const OUString& rDirPath );
232 : ErrCode Execute( SfxItemSet *& rpSet,
233 : OUString& rFilter );
234 : };
235 :
236 : #define SFX2_IMPL_DIALOG_CONFIG 0
237 : #define SFX2_IMPL_DIALOG_SYSTEM 1
238 : #define SFX2_IMPL_DIALOG_OOO 2
239 :
240 : ErrCode FileOpenDialog_Impl( sal_Int16 nDialogType,
241 : sal_Int64 nFlags,
242 : const OUString& rFact,
243 : std::vector<OUString>& rpURLList,
244 : OUString& rFilter,
245 : SfxItemSet *& rpSet,
246 : const OUString* pPath = NULL,
247 : sal_Int16 nDialog = SFX2_IMPL_DIALOG_CONFIG,
248 : const OUString& rStandardDir = OUString(),
249 : const ::com::sun::star::uno::Sequence< OUString >& rBlackList = ::com::sun::star::uno::Sequence< OUString >());
250 :
251 :
252 : ErrCode RequestPassword(const SfxFilter* pCurrentFilter, OUString& aURL, SfxItemSet* pSet);
253 : }
254 :
255 : #endif
256 :
257 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
