ucb/source/ucp/ftp/ftpcontent.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ftpcontent.hxx,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _FTP_FTPCONTENT_HXX
  32 #define _FTP_FTPCONTENT_HXX
  33
  34 #include <ucbhelper/contenthelper.hxx>
  35 #include <com/sun/star/ucb/InsertCommandArgument.hpp>
  36 #include <com/sun/star/ucb/XContentCreator.hpp>
  37 #include "ftpurl.hxx"
  38
  39
  40 namespace com { namespace sun { namespace star { namespace beans {
  41     struct Property;
  42     struct PropertyValue;
  43 } } } }
  44
  45 namespace com { namespace sun { namespace star { namespace sdbc {
  46     class XRow;
  47 } } } }
  48
  49
  50 namespace ftp
  51 {
  52
  53 //=========================================================================
  54
  55 // UNO service name for the content.
  56 #define FTP_CONTENT_SERVICE_NAME "com.sun.star.ucb.FTPContent"
  57
  58 //=========================================================================
  59
  60     struct ContentProperties
  61     {
  62         ::rtl::OUString aTitle;                 // Title
  63         ::rtl::OUString aContentType;   // ContentType
  64         sal_Bool        bIsDocument;    // IsDocument
  65         sal_Bool        bIsFolder;      // IsFolder
  66
  67         ContentProperties()
  68             : bIsDocument( sal_True ), bIsFolder( sal_False ) {}
  69     };
  70
  71 //=========================================================================
  72
  73     class FTPContentProvider;
  74
  75 //=========================================================================
  76
  77     class FTPContent
  78         : public ::ucbhelper::ContentImplHelper,
  79           public com::sun::star::ucb::XContentCreator
  80     {
  81     public:
  82
  83         FTPContent( const ::com::sun::star::uno::Reference<
  84                     ::com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
  85                     FTPContentProvider* pProvider,
  86                     const ::com::sun::star::uno::Reference<
  87                     ::com::sun::star::ucb::XContentIdentifier >& Identifier);
  88
  89         FTPContent( const ::com::sun::star::uno::Reference<
  90                     ::com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
  91                     FTPContentProvider* pProvider,
  92                     const ::com::sun::star::uno::Reference<
  93                     ::com::sun::star::ucb::XContentIdentifier >& Identifier,
  94                     const FTPURL& FtpUrl);
  95
  96         FTPContent( const ::com::sun::star::uno::Reference<
  97                     ::com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
  98                     FTPContentProvider* pProvider,
  99                     const ::com::sun::star::uno::Reference<
 100                     ::com::sun::star::ucb::XContentIdentifier >& Identifier,
 101                     const com::sun::star::ucb::ContentInfo& aInfo);
 102
 103
 104         virtual ~FTPContent();
 105
 106         // XInterface
 107         XINTERFACE_DECL()
 108
 109         // XTypeProvider
 110         XTYPEPROVIDER_DECL()
 111
 112         // XServiceInfo
 113         XSERVICEINFO_DECL()
 114
 115         // XContent
 116         virtual rtl::OUString SAL_CALL
 117         getContentType()
 118             throw( com::sun::star::uno::RuntimeException );
 119
 120         // XCommandProcessor
 121         virtual com::sun::star::uno::Any SAL_CALL
 122         execute( const com::sun::star::ucb::Command& aCommand,
 123                  sal_Int32 CommandId,
 124                  const com::sun::star::uno::Reference<
 125                  com::sun::star::ucb::XCommandEnvironment >& Environment )
 126             throw( com::sun::star::uno::Exception,
 127                    com::sun::star::ucb::CommandAbortedException,
 128                    com::sun::star::uno::RuntimeException );
 129
 130         virtual void SAL_CALL
 131         abort(sal_Int32 CommandId)
 132             throw( com::sun::star::uno::RuntimeException);
 133
 134         // XContentCreator
 135         virtual com::sun::star::uno::Sequence<
 136         com::sun::star::ucb::ContentInfo > SAL_CALL
 137         queryCreatableContentsInfo(  )
 138             throw (com::sun::star::uno::RuntimeException);
 139
 140         virtual com::sun::star::uno::Reference<
 141         com::sun::star::ucb::XContent > SAL_CALL
 142         createNewContent( const com::sun::star::ucb::ContentInfo& Info )
 143             throw (com::sun::star::uno::RuntimeException);
 144
 145         // XChild
 146
 147         virtual ::com::sun::star::uno::Reference<
 148         ::com::sun::star::uno::XInterface > SAL_CALL
 149         getParent(  )
 150             throw (::com::sun::star::uno::RuntimeException);
 151
 152         virtual void SAL_CALL
 153         setParent( const ::com::sun::star::uno::Reference<
 154                    ::com::sun::star::uno::XInterface >& Parent )
 155             throw (::com::sun::star::lang::NoSupportException,
 156                    ::com::sun::star::uno::RuntimeException);
 157
 158
 159     private:
 160
 161         FTPContentProvider *m_pFCP;
 162         FTPURL              m_aFTPURL;
 163         bool                m_bInserted;
 164         bool                m_bTitleSet;
 165         com::sun::star::ucb::ContentInfo m_aInfo;
 166
 167         virtual com::sun::star::uno::Sequence< com::sun::star::beans::Property >
 168         getProperties( const com::sun::star::uno::Reference<
 169                        com::sun::star::ucb::XCommandEnvironment > & xEnv );
 170
 171
 172         virtual com::sun::star::uno::Sequence<
 173         com::sun::star::ucb::CommandInfo>
 174         getCommands(const com::sun::star::uno::Reference<
 175                     com::sun::star::ucb::XCommandEnvironment > & xEnv);
 176
 177
 178         virtual ::rtl::OUString getParentURL();
 179
 180         com::sun::star::uno::Reference<com::sun::star::sdbc::XRow>
 181         getPropertyValues(
 182             const com::sun::star::uno::Sequence<
 183             com::sun::star::beans::Property>& seqProp,
 184             const com::sun::star::uno::Reference<
 185             com::sun::star::ucb::XCommandEnvironment >& Environment
 186         );
 187
 188         com::sun::star::uno::Sequence<com::sun::star::uno::Any>
 189         setPropertyValues(
 190             const ::com::sun::star::uno::Sequence<
 191             ::com::sun::star::beans::PropertyValue>& seqPropVal);
 192
 193         void insert(const com::sun::star::ucb::InsertCommandArgument&,
 194                     const com::sun::star::uno::Reference<
 195                     com::sun::star::ucb::XCommandEnvironment>&);
 196     };
 197
 198 }
 199
 200 #endif