fpicker/source/office/fpsmartcontent.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 #pragma once
  21
  22 #include "fpinteraction.hxx"
  23
  24 #include <com/sun/star/ucb/XCommandEnvironment.hpp>
  25 #include <ucbhelper/content.hxx>
  26 #include <rtl/ref.hxx>
  27 #include <memory>
  28 #include <optional>
  29
  30
  31 namespace svt
  32 {
  33
  34
  35     //= SmartContent
  36
  37     /** a "smart content" which basically wraps a UCB content, but caches some information
  38         so that repeatedly recreating it may be faster
  39     */
  40     class SmartContent
  41     {
  42     public:
  43         enum State
  44         {
  45             NOT_BOUND,  // never bound
  46             UNKNOWN,    // bound, but validity is unknown
  47             VALID,      // bound to a URL, and valid
  48             INVALID     // bound to a URL, and invalid
  49         };
  50
  51     private:
  52         OUString                                               m_sURL;
  53         std::optional<::ucbhelper::Content>                    m_oContent;
  54         State                                                  m_eState;
  55         css::uno::Reference < css::ucb::XCommandEnvironment >  m_xCmdEnv;
  56         rtl::Reference<::svt::OFilePickerInteractionHandler>   m_xOwnInteraction;
  57
  58     private:
  59         enum Type { Folder, Document };
  60         /// checks if the currently bound content is a folder or document
  61         bool implIs( const OUString& _rURL, Type _eType );
  62
  63         SmartContent( const SmartContent& _rSource ) = delete;
  64         SmartContent& operator=( const SmartContent& _rSource ) = delete;
  65
  66     public:
  67         SmartContent();
  68         explicit SmartContent( const OUString& _rInitialURL );
  69         ~SmartContent();
  70
  71     public:
  72
  73         /** create and set a specialized interaction handler at the internal used command environment.
  74
  75             @param eInterceptions
  76                     will be directly forwarded to OFilePickerInteractionHandler::enableInterceptions()
  77         */
  78         void enableOwnInteractionHandler(::svt::OFilePickerInteractionHandler::EInterceptedInteractions eInterceptions);
  79
  80         /** disable the specialized interaction handler and use the global UI interaction handler only.
  81         */
  82         void enableDefaultInteractionHandler();
  83
  84         /** return the internal used interaction handler object ...
  85             Because this pointer will be valid only, if the uno object is hold
  86             alive by its uno reference (and this reference is set on the
  87             command environment) we must return NULL, in case this environment does
  88             not exist!
  89         */
  90         ::svt::OFilePickerInteractionHandler* getOwnInteractionHandler() const;
  91
  92         /** describes different types of interaction handlers
  93          */
  94         enum InteractionHandlerType
  95         {
  96             IHT_NONE,
  97             IHT_OWN,
  98             IHT_DEFAULT
  99         };
 100
 101         /** return the type of the internal used interaction handler object ...
 102
 103             @seealso InteractionHandlerType
 104         */
 105         InteractionHandlerType queryCurrentInteractionHandler() const;
 106
 107         /** disable internal used interaction handler object ...
 108          */
 109         void disableInteractionHandler();
 110
 111         /** returns the current state of the content
 112
 113             @seealso State
 114         */
 115         State       getState( ) const { return m_eState; }
 116
 117         /** checks if the content is valid
 118             <p>Note that "not (is valid)" is not the same as "is invalid"</p>
 119         */
 120         bool    isValid( ) const { return VALID == getState(); }
 121
 122         /** checks if the content is valid
 123             <p>Note that "not (is invalid)" is not the same as "is valid"</p>
 124         */
 125         bool    isInvalid( ) const { return INVALID == getState(); }
 126
 127         /** checks if the content is bound
 128         */
 129         bool    isBound( ) const { return NOT_BOUND != getState(); }
 130
 131         /** returns the URL of the content
 132         */
 133         OUString const & getURL() const { return m_oContent ? m_oContent->getURL() : m_sURL; }
 134
 135         /** (re)creates the content for the given URL
 136
 137             <p>Note that getState will return either UNKNOWN or INVALID after the call returns,
 138             but never VALID. The reason is that there are content providers which allow to construct
 139             content objects, even if the respective contents are not accessible. They tell about this
 140             only upon working with the content object (e.g. when asking for the IsFolder).</p>
 141
 142             @postcond
 143                 <member>getState</member> does not return NOT_BOUND after the call returns
 144         */
 145         void    bindTo( const OUString& _rURL );
 146
 147         /** retrieves the title of the content
 148             @precond
 149                 the content is bound and not invalid
 150         */
 151         void    getTitle( OUString& /* [out] */ _rTitle );
 152
 153         /** checks if the content has a parent folder
 154             @precond
 155                 the content is bound and not invalid
 156         */
 157         bool    hasParentFolder( );
 158
 159         /** checks if sub folders below the content can be created
 160             @precond
 161                 the content is bound and not invalid
 162         */
 163         bool    canCreateFolder( );
 164
 165         /** creates a new folder with the given title and return the corresponding URL.
 166
 167             @return
 168                 the URL of the created folder or an empty string
 169           */
 170         OUString    createFolder( const OUString& _rTitle );
 171
 172         /** binds to the given URL, checks whether or not it refers to a folder
 173
 174             @postcond
 175                 the content is not in the state UNKNOWN
 176         */
 177         bool    isFolder( const OUString& _rURL )
 178         {
 179             return implIs( _rURL, Folder );
 180         }
 181
 182         /** checks if the content is existent (it is if and only if it is a document or a folder)
 183         */
 184         bool    is( const OUString& _rURL )
 185         {
 186             return  implIs( _rURL, Folder ) || implIs( _rURL, Document );
 187         }
 188
 189         bool    isFolder( )     { return isFolder( getURL() ); }
 190     };
 191
 192
 193 } // namespace svt
 194
 195
 196 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */