offapi/com/sun/star/util/XDataEditor.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: XDataEditor.idl,v $
  10  * $Revision: 1.8 $
  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_util_XDataEditor_idl__
  31 #define __com_sun_star_util_XDataEditor_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_util_XDataEditorListener_idl__
  38 #include <com/sun/star/util/XDataEditorListener.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {  module util {
  44
  45 /** connects to a model and broadcasts status change events.
  46  */
  47 published interface XDataEditor: com::sun::star::uno::XInterface
  48 {
  49     /** makes the data editor visible to the user.
  50      */
  51     void show();
  52
  53     //--------------------------------------------------------------------------
  54     /** connects the data editor to a data model.
  55      */
  56     void setModel( [in] com::sun::star::uno::XInterface model );
  57
  58     //--------------------------------------------------------------------------
  59     /** @returns
  60             the data model which was set by <method>XDataEditor::setModel</method>.
  61      */
  62     com::sun::star::uno::XInterface getModel();
  63
  64     //--------------------------------------------------------------------------
  65     /** registers a listener to receive <type>DataEditorEvent</type>s.
  66      */
  67     void addDataEditorListener( [in] XDataEditorListener listener );
  68
  69     //--------------------------------------------------------------------------
  70     /** unregisters a listener which received <type>DataEditorEvent</type>s.
  71      */
  72     void removeDataEditorListener( [in] XDataEditorListener listener );
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif