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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_XContent_idl__
  20 #define __com_sun_star_ucb_XContent_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/XContentIdentifier.idl>
  24 #include <com/sun/star/ucb/XContentEventListener.idl>
  25
  26
  27
  28 module com { module sun { module star { module ucb {
  29
  30 /** specifies a content with a type and an identifier, which is able to manage
  31     listeners for events that are related to contents.
  32
  33      @version  1.0
  34      @author   Kai Sommerfeld
  35      @see      XContentIdentifier
  36      @see      XContentEventListener
  37 */
  38 published interface XContent: com::sun::star::uno::XInterface
  39 {
  40     /** returns the identifier of the content.
  41
  42         @returns
  43         the identifier.
  44     */
  45     com::sun::star::ucb::XContentIdentifier getIdentifier();
  46
  47     /** returns a type string, which is unique for that type of content (e.g.
  48         "application/vnd.sun.star.hierarchy-folder").
  49
  50         @returns
  51         the content type string.
  52     */
  53     string getContentType();
  54
  55     /** adds a listener for content events.
  56
  57         @param Listener
  58         the listener to add.
  59
  60         @see ContentEvent
  61     */
  62     void addContentEventListener(
  63                     [in] com::sun::star::ucb::XContentEventListener Listener );
  64
  65     /** removes a listener for content events.
  66
  67         @param Listener
  68         the listener to remove.
  69
  70         @see ContentEvent
  71     */
  72     void removeContentEventListener(
  73                     [in] com::sun::star::ucb::XContentEventListener Listener );
  74
  75 };
  76
  77
  78 }; }; }; };
  79
  80 #endif
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */