offapi/com/sun/star/util/XDataEditor.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_util_XDataEditor_idl__
  20 #define __com_sun_star_util_XDataEditor_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/util/XDataEditorListener.idl>
  25
  26
  27 module com {  module sun {  module star {  module util {
  28
  29 /** connects to a model and broadcasts status change events.
  30  */
  31 published interface XDataEditor: com::sun::star::uno::XInterface
  32 {
  33     /** makes the data editor visible to the user.
  34      */
  35     void show();
  36
  37     /** connects the data editor to a data model.
  38      */
  39     void setModel( [in] com::sun::star::uno::XInterface model );
  40
  41     /** @returns
  42             the data model which was set by XDataEditor::setModel().
  43      */
  44     com::sun::star::uno::XInterface getModel();
  45
  46     /** registers a listener to receive `DataEditorEvent`s.
  47      */
  48     void addDataEditorListener( [in] XDataEditorListener listener );
  49
  50     /** unregisters a listener.
  51      */
  52     void removeDataEditorListener( [in] XDataEditorListener listener );
  53 };
  54
  55
  56 }; }; }; };
  57
  58 #endif
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */