offapi/com/sun/star/ucb/XContent.idl

   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: XContent.idl,v $
  10  * $Revision: 1.9 $
  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 #ifndef __com_sun_star_ucb_XContent_idl__
  31 #define __com_sun_star_ucb_XContent_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_XContentIdentifier_idl__
  38 #include <com/sun/star/ucb/XContentIdentifier.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_XContentEventListener_idl__
  42 #include <com/sun/star/ucb/XContentEventListener.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module ucb {
  49
  50 //=============================================================================
  51 /** specifies a content with a type and an identifier, which is able to manage
  52     listeners for events that are related to contents.
  53
  54      @version  1.0
  55      @author   Kai Sommerfeld
  56      @see      XContentIdentifier
  57      @see      XContentEventListener
  58 */
  59 published interface XContent: com::sun::star::uno::XInterface
  60 {
  61     //-------------------------------------------------------------------------
  62     /** returns the identifier of the content.
  63
  64         @returns
  65         the identifier.
  66     */
  67     com::sun::star::ucb::XContentIdentifier getIdentifier();
  68
  69     //-------------------------------------------------------------------------
  70     /** returns a type string, which is unique for that type of content (e.g.
  71         "application/vnd.sun.star.hierarchy-folder").
  72
  73         @returns
  74         the content type string.
  75     */
  76     string getContentType();
  77
  78     //-------------------------------------------------------------------------
  79     /** adds a listener for content events.
  80
  81         @param Listener
  82         the listener to add.
  83
  84         @see ContentEvent
  85     */
  86     [oneway] void addContentEventListener(
  87                     [in] com::sun::star::ucb::XContentEventListener Listener );
  88
  89     //-------------------------------------------------------------------------
  90     /** removes a listener for content events.
  91
  92         @param Listener
  93         the listener to remove.
  94
  95         @see ContentEvent
  96     */
  97     [oneway] void removeContentEventListener(
  98                     [in] com::sun::star::ucb::XContentEventListener Listener );
  99
 100 };
 101
 102 //=============================================================================
 103
 104 }; }; }; };
 105
 106 #endif