Version 5.4.3.2, tag libreoffice-5.4.3.2
[LibreOffice.git] / include / svx / databaselocationinput.hxx
blobb20846c80ce792cd784e545c0461ab176d2cc885
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_SVX_DATABASELOCATIONINPUT_HXX
21 #define INCLUDED_SVX_DATABASELOCATIONINPUT_HXX
23 #include <svx/svxdllapi.h>
24 #include <com/sun/star/uno/XComponentContext.hpp>
26 #include <memory>
28 class PushButton;
29 namespace svt { class OFileURLControl; }
31 namespace svx
35 //= DatabaseLocationInputController
37 class DatabaseLocationInputController_Impl;
38 /** helper class to control controls needed to input a database location
40 If you allow, in your dialog, to save a database document, then you usually
41 have a OFileURLControl for inputting the actual location, and a push button
42 to browse for a location.
44 This helper class controls such two UI elements.
46 class SAL_WARN_UNUSED SVX_DLLPUBLIC DatabaseLocationInputController
48 public:
49 DatabaseLocationInputController(
50 const css::uno::Reference<css::uno::XComponentContext>& _rContext,
51 ::svt::OFileURLControl& _rLocationInput,
52 PushButton& _rBrowseButton
54 ~DatabaseLocationInputController();
56 /** sets the given URL at the input control, after translating it into a system path
58 void setURL( const OUString& _rURL );
60 /** returns the current database location, in form of an URL (not a system path)
62 OUString getURL() const;
64 /** prepares committing the database location entered in the input field
66 Effectively, this method checks whether the file in the location already
67 exists, and if so, it asks the user whether to overwrite it.
69 If the method is called multiple times, this check only happens when the location
70 changed since the last call.
72 bool prepareCommit();
74 private:
75 ::std::unique_ptr< DatabaseLocationInputController_Impl >
76 m_pImpl;
83 #endif // INCLUDED_SVX_DATABASELOCATIONINPUT_HXX
85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */