/*************************************************************************
*
* $RCSfile: HierarchyFolderContent.idl,v $
*
* $Revision: 1.5 $
*
* last change: $Author: obo $ $Date: 2002-08-19 16:15:01 $
*
* 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_HierarchyFolderContent_idl__
#define __com_sun_star_ucb_HierarchyFolderContent_idl__
#ifndef __com_sun_star_lang_XComponent_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XContent_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
#include
#endif
#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
#include
#endif
#ifndef __com_sun_star_beans_XPropertyContainer_idl__
#include
#endif
#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
#include
#endif
#ifndef __com_sun_star_container_XChild_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XContentCreator_idl__
#include
#endif
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** A HCP Folder is a container for other HCP Folders and HCP Links.
@see com::sun::star::ucb::HierarchyContentProvider
@see com::sun::star::ucb::HierarchyRootFolderContent
@see com::sun::star::ucb::HierarchyLinkContent
*/
service HierarchyFolderContent
{
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::lang::XComponent;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::ucb::XContent;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
Supported Commands
-
getCommandInfo
-
getPropertySetInfo
-
getPropertyValues
-
setPropertyValues
-
insert ( makes a newly created folder persistent )
-
delete
-
open
-
transfer ( only transfers from one hierarchy folder to another supported )
Supported Properties
-
string ContentType ( read-only, always "application/vnd.sun.star.hier-folder" )
-
boolean IsDocument ( read-only, always false )
-
boolean IsFolder ( read-only, always true )
-
string Title
*/
interface com::sun::star::ucb::XCommandProcessor;
//-------------------------------------------------------------------------
/** is an enhanced version of XCommandProcessor that has an
additional method for releasing command identifiers obtained via
XCommandProcessor::createCommandIdentifier to avoid
resource leaks. For a detailed description of the problem refer to
XCommandProcessor2::releaseCommandIdentifier.
Where many existing Content implementations do not
(yet), every new implementation should support this interface.
*/
[optional] interface com::sun::star::ucb::XCommandProcessor2;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertiesChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertyContainer;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::ucb::XCommandInfoChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::container::XChild;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
A HCP Folder can create other HCP Folders and HCP Links. To create
a new child of a HCP Folder:
-
Let the parent folder create a new content by calling
XContentCreator::createNewContent on it. The content
type to use for new folders is "application/vnd.sun.star.hier-folder".
To create a new link, use the type "application/vnd.sun.star.hier-link".
-
Set a title at the new folder / link. ( Let the new child execute
the command "setPropertyValues", which sets at least the property
"Title" to a non-empty value ). For a link, you need to set the
property "TargetURL" as well to a non-empty value.
-
Let the new child ( not the parent! ) execute the command "insert".
This will commit the creation process.
*/
interface com::sun::star::ucb::XContentCreator;
};
//=============================================================================
}; }; }; };
#endif