diff options
Diffstat (limited to 'include/ucbhelper/simplenameclashresolverequest.hxx')
-rw-r--r-- | include/ucbhelper/simplenameclashresolverequest.hxx | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/include/ucbhelper/simplenameclashresolverequest.hxx b/include/ucbhelper/simplenameclashresolverequest.hxx new file mode 100644 index 000000000000..be789fd6a148 --- /dev/null +++ b/include/ucbhelper/simplenameclashresolverequest.hxx @@ -0,0 +1,77 @@ +/* -*- 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 _UCBHELPER_SIMPLENAMECLASHRESOLVEREQUEST_HXX +#define _UCBHELPER_SIMPLENAMECLASHRESOLVEREQUEST_HXX + +#include <rtl/ref.hxx> +#include <ucbhelper/interactionrequest.hxx> +#include "ucbhelper/ucbhelperdllapi.h" + +namespace ucbhelper { + +/** + * This class implements a simple name clash resolve interaction request. + * Instances can be passed directly to XInteractionHandler::handle(...). Each + * instance contains a NameClashResolveRequest and two interaction + * continuations: "Abort" and "SupplyName". Another continuation + * ("ReplaceExistingData") may be supplied optionally. + * + * @see com::sun::star::ucb::NameClashResolveRequest + * @see InteractionAbort + * @see InteractioneplaceExistingData + * @see InteractionSupplyName + */ +class UCBHELPER_DLLPUBLIC SimpleNameClashResolveRequest : public ucbhelper::InteractionRequest +{ + rtl::Reference< InteractionSupplyName > m_xNameSupplier; + +public: + /** + * Constructor. + * + * @param rTargetFolderURL contains the URL of the folder that contains + * the clashing resource. + * @param rClashingName contains the clashing name. + * @param rProposedNewName contains a proposal for the new name or is + * empty. + * @param bSupportsOverwriteData indicates whether an + * InteractionReplaceExistingData continuation shall be supplied + * with the interaction request. + */ + SimpleNameClashResolveRequest( const OUString & rTargetFolderURL, + const OUString & rClashingName, + const OUString & rProposedNewName, + sal_Bool bSupportsOverwriteData = sal_True ); + /** + * This method returns the new name that was supplied by the interaction + * handler. + * + * @return the new name, if supplied. + */ + const OUString getNewName() const + { return m_xNameSupplier->getName(); } + +}; + +} // namespace ucbhelper + +#endif /* !_UCBHELPER_SIMPLENAMECLASHRESOLVEREQUEST_HXX */ + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |