offapi/com/sun/star/form/XLoadable.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: XLoadable.idl,v $
  10  * $Revision: 1.11 $
  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_form_XLoadable_idl__
  31 #define __com_sun_star_form_XLoadable_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_form_XLoadListener_idl__
  38 #include <com/sun/star/form/XLoadListener.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module form {
  44
  45 //=============================================================================
  46
  47 /** provides functionality to implement objects which may be loaded.
  48
  49     <p>The object is typically implemented by high-level objects which can connect to a data source.</p>
  50
  51     @see XLoadListener
  52  */
  53 published interface XLoadable: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     /** loads the data.
  58
  59         <p>If the data is already loaded (->isLoaded), then the method returns silently.
  60         In this case, you should use ->reload.</p>
  61      */
  62     [oneway] void load();
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** unloads the data.
  67      */
  68     [oneway] void unload();
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** does a smart refresh of the object.
  73
  74         <p>The final state will be the same as if unload and load were called, but reload
  75         is the more efficient way to do the same. If the object isn't loaded, nothing happens.</p>
  76      */
  77     [oneway] void reload();
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** returns if the object is in loaded state.
  82      */
  83     boolean isLoaded();
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** adds the specified listener to receive load-related events
  88
  89         @param aListener
  90             the listener to add.
  91      */
  92     [oneway] void addLoadListener( [in] com::sun::star::form::XLoadListener aListener );
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** removes the specified listener.
  97
  98         @param aListener
  99             the listener to remove.
 100      */
 101     [oneway] void removeLoadListener( [in] com::sun::star::form::XLoadListener aListener );
 102 };
 103
 104 }; }; }; };
 105
 106 #endif
 107
 108 /*=============================================================================
 109
 110 =============================================================================*/