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