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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_XContent_idl__
  28 #define __com_sun_star_ucb_XContent_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_ucb_XContentIdentifier_idl__
  35 #include <com/sun/star/ucb/XContentIdentifier.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_ucb_XContentEventListener_idl__
  39 #include <com/sun/star/ucb/XContentEventListener.idl>
  40 #endif
  41
  42
  43 //=============================================================================
  44
  45 module com { module sun { module star { module ucb {
  46
  47 //=============================================================================
  48 /** specifies a content with a type and an identifier, which is able to manage
  49     listeners for events that are related to contents.
  50
  51      @version  1.0
  52      @author   Kai Sommerfeld
  53      @see      XContentIdentifier
  54      @see      XContentEventListener
  55 */
  56 published interface XContent: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59     /** returns the identifier of the content.
  60
  61         @returns
  62         the identifier.
  63     */
  64     com::sun::star::ucb::XContentIdentifier getIdentifier();
  65
  66     //-------------------------------------------------------------------------
  67     /** returns a type string, which is unique for that type of content (e.g.
  68         "application/vnd.sun.star.hierarchy-folder").
  69
  70         @returns
  71         the content type string.
  72     */
  73     string getContentType();
  74
  75     //-------------------------------------------------------------------------
  76     /** adds a listener for content events.
  77
  78         @param Listener
  79         the listener to add.
  80
  81         @see ContentEvent
  82     */
  83     [oneway] void addContentEventListener(
  84                     [in] com::sun::star::ucb::XContentEventListener Listener );
  85
  86     //-------------------------------------------------------------------------
  87     /** removes a listener for content events.
  88
  89         @param Listener
  90         the listener to remove.
  91
  92         @see ContentEvent
  93     */
  94     [oneway] void removeContentEventListener(
  95                     [in] com::sun::star::ucb::XContentEventListener Listener );
  96
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; };
 102
 103 #endif