ucb/source/ucp/odma/odma_contentcaps.cxx

   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: odma_contentcaps.cxx,v $
  10  * $Revision: 1.7 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_ucb.hxx"
  33
  34 /**************************************************************************
  35                                 TODO
  36  **************************************************************************
  37
  38  *************************************************************************/
  39 #include <com/sun/star/beans/Property.hpp>
  40 #include <com/sun/star/beans/PropertyAttribute.hpp>
  41 #include <com/sun/star/beans/PropertyValue.hpp>
  42 #include <com/sun/star/ucb/CommandInfo.hpp>
  43 #include <com/sun/star/ucb/InsertCommandArgument.hpp>
  44 #include <com/sun/star/ucb/OpenCommandArgument2.hpp>
  45 #include <com/sun/star/uno/Sequence.hxx>
  46 #include <com/sun/star/util/DateTime.hpp>
  47 #include <com/sun/star/ucb/TransferInfo.hpp>
  48 #include "odma_content.hxx"
  49
  50 using namespace com::sun::star;
  51 using namespace odma;
  52
  53 //=========================================================================
  54 //
  55 // Content implementation.
  56 //
  57 //=========================================================================
  58
  59 //=========================================================================
  60 //
  61 // IMPORTENT: If any property data ( name / type / ... ) are changed, then
  62 //            Content::getPropertyValues(...) must be adapted too!
  63 //
  64 //=========================================================================
  65
  66 // virtual
  67 uno::Sequence< beans::Property > Content::getProperties(
  68     const uno::Reference< ucb::XCommandEnvironment > & /*xEnv*/ )
  69 {
  70     // @@@ Add additional properties...
  71
  72     // @@@ Note: If your data source supports adding/removing properties,
  73     //           you should implement the interface XPropertyContainer
  74     //           by yourself and supply your own logic here. The base class
  75     //           uses the service "com.sun.star.ucb.Store" to maintain
  76     //           Additional Core properties. But using server functionality
  77     //           is preferred! In fact you should return a table conatining
  78     //           even that dynamicly added properties.
  79
  80 //      osl::Guard< osl::Mutex > aGuard( m_aMutex );
  81
  82     //=================================================================
  83     //
  84     // Supported properties
  85     //
  86     //=================================================================
  87
  88     #define PROPERTY_COUNT 10
  89
  90     static beans::Property aPropertyInfoTable[] =
  91     {
  92         ///////////////////////////////////////////////////////////////
  93         // Required properties
  94         ///////////////////////////////////////////////////////////////
  95         beans::Property(
  96             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "ContentType" ) ),
  97             -1,
  98             getCppuType( static_cast< const rtl::OUString * >( 0 ) ),
  99             beans::PropertyAttribute::BOUND | beans::PropertyAttribute::READONLY
 100         ),
 101         beans::Property(
 102             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "IsDocument" ) ),
 103             -1,
 104             getCppuBooleanType(),
 105             beans::PropertyAttribute::BOUND | beans::PropertyAttribute::READONLY
 106         ),
 107         beans::Property(
 108             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "IsFolder" ) ),
 109             -1,
 110             getCppuBooleanType(),
 111             beans::PropertyAttribute::BOUND | beans::PropertyAttribute::READONLY
 112         ),
 113         beans::Property(
 114             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Title" ) ),
 115             -1,
 116             getCppuType( static_cast< const rtl::OUString * >( 0 ) ),
 117             beans::PropertyAttribute::BOUND
 118         ),
 119         ///////////////////////////////////////////////////////////////
 120         // Optional standard properties
 121         ///////////////////////////////////////////////////////////////
 122         beans::Property(
 123             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "DateCreated" ) ),
 124             -1,
 125             getCppuType(static_cast< const util::DateTime * >( 0 ) ),
 126             beans::PropertyAttribute::BOUND | beans::PropertyAttribute::READONLY
 127         ),
 128         beans::Property(
 129             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "DateModified" ) ),
 130             -1,
 131             getCppuType(static_cast< const util::DateTime * >( 0 ) ),
 132             beans::PropertyAttribute::BOUND | beans::PropertyAttribute::READONLY
 133         ),
 134         beans::Property(
 135             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "IsReadOnly" ) ),
 136             -1,
 137             getCppuBooleanType(),
 138             beans::PropertyAttribute::BOUND | beans::PropertyAttribute::READONLY
 139         ),
 140         ///////////////////////////////////////////////////////////////
 141         // New properties
 142         ///////////////////////////////////////////////////////////////
 143         beans::Property(
 144             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Author" ) ),
 145             -1,
 146             getCppuType( static_cast< const rtl::OUString * >( 0 ) ),
 147             beans::PropertyAttribute::BOUND
 148         ),
 149         beans::Property(
 150             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Subject" ) ),
 151             -1,
 152             getCppuType( static_cast< const rtl::OUString * >( 0 ) ),
 153             beans::PropertyAttribute::BOUND
 154         ),
 155         beans::Property(
 156             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Keywords" ) ),
 157             -1,
 158             getCppuType( static_cast< const rtl::OUString * >( 0 ) ),
 159             beans::PropertyAttribute::BOUND
 160         )
 161     };
 162     return uno::Sequence<
 163             beans::Property >( aPropertyInfoTable, PROPERTY_COUNT );
 164 }
 165
 166 //=========================================================================
 167 // virtual
 168 uno::Sequence< ucb::CommandInfo > Content::getCommands(
 169     const uno::Reference< ucb::XCommandEnvironment > & /*xEnv*/ )
 170 {
 171     // @@@ Add additional commands...
 172
 173 //      osl::Guard< osl::Mutex > aGuard( m_aMutex );
 174
 175     //=================================================================
 176     //
 177     // Supported commands
 178     //
 179     //=================================================================
 180
 181     #define COMMAND_COUNT 8
 182
 183     static ucb::CommandInfo aCommandInfoTable[] =
 184     {
 185         ///////////////////////////////////////////////////////////////
 186         // Required commands
 187         ///////////////////////////////////////////////////////////////
 188         ucb::CommandInfo(
 189             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "getCommandInfo" ) ),
 190             -1,
 191             getCppuVoidType()
 192         ),
 193         ucb::CommandInfo(
 194             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "getPropertySetInfo" ) ),
 195             -1,
 196             getCppuVoidType()
 197         ),
 198         ucb::CommandInfo(
 199             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "getPropertyValues" ) ),
 200             -1,
 201             getCppuType(
 202                 static_cast< uno::Sequence< beans::Property > * >( 0 ) )
 203         ),
 204         ucb::CommandInfo(
 205             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "setPropertyValues" ) ),
 206             -1,
 207             getCppuType(
 208                 static_cast< uno::Sequence< beans::PropertyValue > * >( 0 ) )
 209         ),
 210         ///////////////////////////////////////////////////////////////
 211         // Optional standard commands
 212         ///////////////////////////////////////////////////////////////
 213 /*
 214         ucb::CommandInfo(
 215             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "delete" ) ),
 216             -1,
 217             getCppuBooleanType()
 218         ),
 219 */
 220         ucb::CommandInfo(
 221             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "insert" ) ),
 222             -1,
 223             getCppuType(
 224                 static_cast< ucb::InsertCommandArgument * >( 0 ) )
 225         ),
 226         ucb::CommandInfo(
 227             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "open" ) ),
 228             -1,
 229             getCppuType( static_cast< ucb::OpenCommandArgument2 * >( 0 ) )
 230         ),
 231         ucb::CommandInfo(
 232             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "close" ) ),
 233             -1,
 234             getCppuVoidType( )
 235         ),
 236         ucb::CommandInfo(
 237             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "transfer" ) ),
 238             -1,
 239             getCppuType( static_cast< ucb::TransferInfo * >( 0 ) )
 240         )
 241
 242         ///////////////////////////////////////////////////////////////
 243         // New commands
 244         ///////////////////////////////////////////////////////////////
 245     };
 246
 247     return uno::Sequence<
 248             ucb::CommandInfo >( aCommandInfoTable, COMMAND_COUNT );
 249 }
 250