include/ucbhelper/simplenameclashresolverequest.hxx

   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
  20 #ifndef INCLUDED_UCBHELPER_SIMPLENAMECLASHRESOLVEREQUEST_HXX
  21 #define INCLUDED_UCBHELPER_SIMPLENAMECLASHRESOLVEREQUEST_HXX
  22
  23 #include <rtl/ref.hxx>
  24 #include <ucbhelper/interactionrequest.hxx>
  25 #include <ucbhelper/ucbhelperdllapi.h>
  26
  27 namespace ucbhelper {
  28
  29 /**
  30   * This class implements a simple name clash resolve interaction request.
  31   * Instances can be passed directly to XInteractionHandler::handle(...). Each
  32   * instance contains a NameClashResolveRequest and two interaction
  33   * continuations: "Abort" and "SupplyName". Another continuation
  34   * ("ReplaceExistingData") may be supplied optionally.
  35   *
  36   * @see com::sun::star::ucb::NameClashResolveRequest
  37   * @see InteractionAbort
  38   * @see InteractioneplaceExistingData
  39   * @see InteractionSupplyName
  40   */
  41 class UCBHELPER_DLLPUBLIC SimpleNameClashResolveRequest : public ucbhelper::InteractionRequest
  42 {
  43     rtl::Reference< InteractionSupplyName > m_xNameSupplier;
  44
  45 public:
  46     /**
  47       * Constructor.
  48       *
  49       * @param rTargetFolderURL contains the URL of the folder that contains
  50       *        the clashing resource.
  51       * @param rClashingName contains the clashing name.
  52       * @param rProposedNewName contains a proposal for the new name or is
  53       *        empty.
  54       * @param bSupportsOverwriteData indicates whether an
  55       *        InteractionReplaceExistingData continuation shall be supplied
  56       *        with the interaction request.
  57       */
  58     SimpleNameClashResolveRequest( const OUString & rTargetFolderURL,
  59                                    const OUString & rClashingName,
  60                                    const OUString & rProposedNewName,
  61                                    sal_Bool bSupportsOverwriteData = sal_True );
  62     /**
  63       * This method returns the new name that was supplied by the interaction
  64       * handler.
  65       *
  66       * @return the new name, if supplied.
  67       */
  68     const OUString getNewName() const
  69     { return m_xNameSupplier->getName(); }
  70
  71 };
  72
  73 } // namespace ucbhelper
  74
  75 #endif /* ! INCLUDED_UCBHELPER_SIMPLENAMECLASHRESOLVEREQUEST_HXX */
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */