1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_ucb_FTPContent_idl__ 24cdf0e10cSrcweir#define __com_sun_star_ucb_FTPContent_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_lang_XComponent_idl__ 27cdf0e10cSrcweir#include <com/sun/star/lang/XComponent.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContent_idl__ 31cdf0e10cSrcweir#include <com/sun/star/ucb/XContent.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContentCreator_idl__ 35cdf0e10cSrcweir#include <com/sun/star/ucb/XContentCreator.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XCommandProcessor_idl__ 39cdf0e10cSrcweir#include <com/sun/star/ucb/XCommandProcessor.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__ 43cdf0e10cSrcweir#include <com/sun/star/beans/XPropertiesChangeNotifier.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertyContainer_idl__ 47cdf0e10cSrcweir#include <com/sun/star/beans/XPropertyContainer.idl> 48cdf0e10cSrcweir#endif 49cdf0e10cSrcweir 50cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__ 51cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl> 52cdf0e10cSrcweir#endif 53cdf0e10cSrcweir 54cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__ 55cdf0e10cSrcweir#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl> 56cdf0e10cSrcweir#endif 57cdf0e10cSrcweir 58cdf0e10cSrcweir#ifndef __com_sun_star_container_XChild_idl__ 59cdf0e10cSrcweir#include <com/sun/star/container/XChild.idl> 60cdf0e10cSrcweir#endif 61cdf0e10cSrcweir 62cdf0e10cSrcweir//============================================================================= 63cdf0e10cSrcweir 64cdf0e10cSrcweirmodule com { module sun { module star { module ucb { 65cdf0e10cSrcweir 66cdf0e10cSrcweir//============================================================================= 67cdf0e10cSrcweir/** A FTPContent provides an object representing either a (ftp-server-side) 68cdf0e10cSrcweir directory object allowing listing of children or a content object providing 69cdf0e10cSrcweir access to a (ftp-server-side) file. 70cdf0e10cSrcweir 71cdf0e10cSrcweir @see com::sun::star::ucb::FTPContentProvider 72cdf0e10cSrcweir 73*34c958abSJürgen Schmidt @since OpenOffice 1.1.2 74cdf0e10cSrcweir*/ 75cdf0e10cSrcweirpublished service FTPContent 76cdf0e10cSrcweir{ 77cdf0e10cSrcweir //------------------------------------------------------------------------- 78cdf0e10cSrcweir /** This interface is implemented according to the specification of 79cdf0e10cSrcweir service <type>Content</type>. 80cdf0e10cSrcweir */ 81cdf0e10cSrcweir interface com::sun::star::lang::XComponent; 82cdf0e10cSrcweir 83cdf0e10cSrcweir //------------------------------------------------------------------------- 84cdf0e10cSrcweir /** This interface is implemented according to the specification of 85cdf0e10cSrcweir service <type>Content</type>. 86cdf0e10cSrcweir */ 87cdf0e10cSrcweir interface com::sun::star::ucb::XContent; 88cdf0e10cSrcweir 89cdf0e10cSrcweir //------------------------------------------------------------------------- 90cdf0e10cSrcweir /** This interface is implemented according to the specification of 91cdf0e10cSrcweir service <type>Content</type>. 92cdf0e10cSrcweir 93cdf0e10cSrcweir <p>An object representing a directory in the file system is able 94cdf0e10cSrcweir to create a new object, which in turn can become the representation 95cdf0e10cSrcweir of a physical file/directory being contained in the initial directory. 96cdf0e10cSrcweir The precise way is the following: 97cdf0e10cSrcweir 98cdf0e10cSrcweir <p> 99cdf0e10cSrcweir 100cdf0e10cSrcweir <ol> 101cdf0e10cSrcweir <li> 102cdf0e10cSrcweir Let the parent folder create a new content by calling 103cdf0e10cSrcweir <member>XContentCreator::createNewContent</member> on it. The content 104cdf0e10cSrcweir type to use for new directories is 105cdf0e10cSrcweir "application/vnd.sun.staroffice.ftp-folder". To create a new file 106cdf0e10cSrcweir use the type "application/vnd.sun.staroffice.ftp-file". 107cdf0e10cSrcweir As return value you get a new file content object. 108cdf0e10cSrcweir </li> 109cdf0e10cSrcweir <li> 110cdf0e10cSrcweir Set a title at the new object by letting it execute 111cdf0e10cSrcweir the command "setPropertyValues", which sets at least the property 112cdf0e10cSrcweir "Title" to a non-empty value ). 113cdf0e10cSrcweir </li> 114cdf0e10cSrcweir <li> 115cdf0e10cSrcweir Let the new object ( not the parent! ) execute the command "insert". 116cdf0e10cSrcweir This will create the corresponding physical file or directory. 117cdf0e10cSrcweir For files, you need to supply the implementation of 118cdf0e10cSrcweir an <type scope="com::sun::star::io">XInputStream</type> with the 119cdf0e10cSrcweir command's parameters, that provides access to the stream data. 120cdf0e10cSrcweir </li> 121cdf0e10cSrcweir </ol> 122cdf0e10cSrcweir 123cdf0e10cSrcweir </p> 124cdf0e10cSrcweir */ 125cdf0e10cSrcweir interface com::sun::star::ucb::XContentCreator; 126cdf0e10cSrcweir 127cdf0e10cSrcweir //------------------------------------------------------------------------- 128cdf0e10cSrcweir /** This interface is implemented according to the specification of 129cdf0e10cSrcweir service <type>Content</type>. 130cdf0e10cSrcweir 131cdf0e10cSrcweir <p> 132cdf0e10cSrcweir 133cdf0e10cSrcweir <b>Supported Commands</b> 134cdf0e10cSrcweir 135cdf0e10cSrcweir <ul> 136cdf0e10cSrcweir <li> 137cdf0e10cSrcweir getCommandInfo 138cdf0e10cSrcweir </li> 139cdf0e10cSrcweir <li> 140cdf0e10cSrcweir getPropertySetInfo 141cdf0e10cSrcweir </li> 142cdf0e10cSrcweir <li> 143cdf0e10cSrcweir getPropertyValues 144cdf0e10cSrcweir </li> 145cdf0e10cSrcweir <li> 146cdf0e10cSrcweir setPropertyValues 147cdf0e10cSrcweir </li> 148cdf0e10cSrcweir <li> 149cdf0e10cSrcweir open 150cdf0e10cSrcweir </li> 151cdf0e10cSrcweir <li> 152cdf0e10cSrcweir insert 153cdf0e10cSrcweir </li> 154cdf0e10cSrcweir <li> 155cdf0e10cSrcweir delete 156cdf0e10cSrcweir </li> 157cdf0e10cSrcweir </ul> 158cdf0e10cSrcweir 159cdf0e10cSrcweir <b>Supported Properties</b> 160cdf0e10cSrcweir <ul> 161cdf0e10cSrcweir <li> 162cdf0e10cSrcweir string ContentType ( read-only, either 163cdf0e10cSrcweir "application/vnd.sun.staroffice.ftp-folder" or 164cdf0e10cSrcweir "application/vnd.sun.staroffice.ftp-file" ) 165cdf0e10cSrcweir </li> 166cdf0e10cSrcweir <li> 167cdf0e10cSrcweir boolean IsDocument ( read-only, always <true/> for files, always 168cdf0e10cSrcweir <false/> for directories ) 169cdf0e10cSrcweir </li> 170cdf0e10cSrcweir <li> 171cdf0e10cSrcweir boolean IsFolder ( read-only ), always <false/> for files, always 172cdf0e10cSrcweir <true/> for directories ) 173cdf0e10cSrcweir </li> 174cdf0e10cSrcweir <li> 175cdf0e10cSrcweir boolean IsReadOnly ( read-only attribute ) 176cdf0e10cSrcweir </li> 177cdf0e10cSrcweir <li> 178cdf0e10cSrcweir string Title ( file name ) 179cdf0e10cSrcweir </li> 180cdf0e10cSrcweir <li> 181cdf0e10cSrcweir hyper Size ( file size ) 182cdf0e10cSrcweir </li> 183cdf0e10cSrcweir <li> 184cdf0e10cSrcweir string Title ( file name ) 185cdf0e10cSrcweir </li> 186cdf0e10cSrcweir <li> 187cdf0e10cSrcweir <type scope="com::sun::star::util">DateTime</type>DateCreated ( read-only ) 188cdf0e10cSrcweir </li> 189cdf0e10cSrcweir </ul> 190cdf0e10cSrcweir </p> 191cdf0e10cSrcweir */ 192cdf0e10cSrcweir interface com::sun::star::ucb::XCommandProcessor; 193cdf0e10cSrcweir 194cdf0e10cSrcweir //------------------------------------------------------------------------- 195cdf0e10cSrcweir /** This interface is implemented according to the specification of 196cdf0e10cSrcweir service <type>Content</type>. 197cdf0e10cSrcweir */ 198cdf0e10cSrcweir interface com::sun::star::beans::XPropertiesChangeNotifier; 199cdf0e10cSrcweir 200cdf0e10cSrcweir //------------------------------------------------------------------------- 201cdf0e10cSrcweir /** This interface is implemented according to the specification of 202cdf0e10cSrcweir service <type>Content</type>. 203cdf0e10cSrcweir */ 204cdf0e10cSrcweir interface com::sun::star::beans::XPropertyContainer; 205cdf0e10cSrcweir 206cdf0e10cSrcweir //------------------------------------------------------------------------- 207cdf0e10cSrcweir /** This interface is implemented according to the specification of 208cdf0e10cSrcweir service <type>Content</type>. 209cdf0e10cSrcweir */ 210cdf0e10cSrcweir interface com::sun::star::beans::XPropertySetInfoChangeNotifier; 211cdf0e10cSrcweir 212cdf0e10cSrcweir //------------------------------------------------------------------------- 213cdf0e10cSrcweir /** This interface is implemented according to the specification of 214cdf0e10cSrcweir service <type>Content</type>. 215cdf0e10cSrcweir */ 216cdf0e10cSrcweir interface com::sun::star::ucb::XCommandInfoChangeNotifier; 217cdf0e10cSrcweir 218cdf0e10cSrcweir //------------------------------------------------------------------------- 219cdf0e10cSrcweir /** This interface is implemented according to the specification of 220cdf0e10cSrcweir service <type>Content</type>. 221cdf0e10cSrcweir */ 222cdf0e10cSrcweir interface com::sun::star::container::XChild; 223cdf0e10cSrcweir}; 224cdf0e10cSrcweir 225cdf0e10cSrcweir//============================================================================= 226cdf0e10cSrcweir 227cdf0e10cSrcweir}; }; }; }; 228cdf0e10cSrcweir 229cdf0e10cSrcweir#endif 230