offapi/com/sun/star/form/XLoadable.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
  20
  21  module com {  module sun {  module star {  module form {
  22
  23
  24 /** provides functionality to implement objects which may be loaded.
  25
  26     <p>The object is typically implemented by high-level objects which can connect to a data source.</p>
  27
  28     @see XLoadListener
  29  */
  30 published interface XLoadable: com::sun::star::uno::XInterface
  31 {
  32
  33     /** loads the data.
  34
  35         <p>If the data is already loaded (->isLoaded), then the method returns silently.
  36         In this case, you should use ->reload.</p>
  37      */
  38     void load();
  39
  40
  41     /** unloads the data.
  42      */
  43     void unload();
  44
  45
  46     /** does a smart refresh of the object.
  47
  48         <p>The final state will be the same as if unload and load were called, but reload
  49         is the more efficient way to do the same. If the object isn't loaded, nothing happens.</p>
  50      */
  51     void reload();
  52
  53
  54     /** returns if the object is in loaded state.
  55      */
  56     boolean isLoaded();
  57
  58
  59     /** adds the specified listener to receive load-related events
  60
  61         @param aListener
  62             the listener to add.
  63      */
  64     void addLoadListener( [in] com::sun::star::form::XLoadListener aListener );
  65
  66
  67     /** removes the specified listener.
  68
  69         @param aListener
  70             the listener to remove.
  71      */
  72     void removeLoadListener( [in] com::sun::star::form::XLoadListener aListener );
  73 };
  74
  75 }; }; }; };
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */