diff options
Diffstat (limited to 'offapi/com/sun/star/ucb/ContentInfo.idl')
-rw-r--r-- | offapi/com/sun/star/ucb/ContentInfo.idl | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/ContentInfo.idl b/offapi/com/sun/star/ucb/ContentInfo.idl new file mode 100644 index 000000000000..203c20075363 --- /dev/null +++ b/offapi/com/sun/star/ucb/ContentInfo.idl @@ -0,0 +1,126 @@ +/************************************************************************* + * + * $RCSfile: ContentInfo.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:22:31 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_ucb_ContentInfo_idl__ +#define __com_sun_star_ucb_ContentInfo_idl__ + +#ifndef __com_sun_star_beans_Property_idl__ +#include <com/sun/star/beans/Property.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ucb { + +//============================================================================= +/** A structure for information about contents. + + @see XContentCreator + @see XCommandExecutor +*/ +struct ContentInfo +{ + //------------------------------------------------------------------------- + /** A type identifier string for a content. + */ + string Type; + + //------------------------------------------------------------------------- + /** Attributes. This may be any flags providing additional information + to the implemantation of the XContentCreator interface. + */ + long Attributes; + + //------------------------------------------------------------------------- + /** This field contains a list with the properties which must be set at + a content that was just created using + <method>XContentCreator::createNewContent</method> before it can be + committed ( via executing the command "insert" at the new content ). + If one of the properties is missing, the insert command will fail. + + In example, a new file system folder content will need a title. The + Properties member of the ContentInfo provided for this kind of + content must include the property "Title". + + <b>Important:</b> The required properties must have one of the + following basic data types ( in order to make it possible to implement + client applications with a small set of generic input methods for the + values ): + + <ul> + <li>boolean + <li>char + <li>byte + <li>string + <li>short + <li>long + <li>hyper + <li>float + <li>double + </ul> + */ + sequence< com::sun::star::beans::Property > Properties; +}; + +//============================================================================= + +}; }; }; }; + +#endif |