odk/examples/java/Spreadsheet/XCalcAddins.idl

   1 /*************************************************************************
   2  *
   3  *  $RCSfile: XCalcAddins.idl,v $
   4  *
   5  *  $Revision: 1.5 $
   6  *
   7  *  last change: $Author: rt $ $Date: 2008-07-11 14:31:08 $
   8  *
   9  *  The Contents of this file are made available subject to the terms of
  10  *  the BSD license.
  11  *
  12  *  Copyright (c) 2003 by Sun Microsystems, Inc.
  13  *  All rights reserved.
  14  *
  15  *  Redistribution and use in source and binary forms, with or without
  16  *  modification, are permitted provided that the following conditions
  17  *  are met:
  18  *  1. Redistributions of source code must retain the above copyright
  19  *     notice, this list of conditions and the following disclaimer.
  20  *  2. Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  24  *     contributors may be used to endorse or promote products derived
  25  *     from this software without specific prior written permission.
  26  *
  27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  30  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  31  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  32  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  33  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  34  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  35  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  36  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  37  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  *************************************************************************/
  40 #ifndef INCLUDED_ORG_OPENOFFICE_SHEET_ADDIN_XCALCADDIN_IDL
  41 #define INCLUDED_ORG_OPENOFFICE_SHEET_ADDIN_XCALCADDIN_IDL
  42
  43 #include <com/sun/star/beans/XPropertySet.idl>
  44 #include <com/sun/star/sheet/AddIn.idl>
  45
  46
  47 module org {
  48   module openoffice {
  49       module sheet {
  50         module addin {
  51       /** Interface with your additional methods.
  52
  53               You may declare several methods. Each method may have
  54               any number of arguments after xOptions.
  55               Furthermore, you could replace the name of the service and
  56               the interface, but only if you want to replace this name in all
  57               your project files. This example will work with tNeccessaryhe default
  58               names.
  59               Interface names should start with an X prefix.
  60            */
  61       interface XCalcAddins
  62       {
  63             /** Declare your methods:
  64                 This is where you could add the declarations of your methods.
  65                 If you want to learn more about
  66                 the IDL syntax including the base types, you could
  67                 visit the following web page:
  68                 http://www.openoffice.org/project/udk/common/man/idl_syntax.html .
  69              */
  70             long getMyFirstValue(
  71                  /** Parameters:
  72                      You could insert further arguments after the
  73                      parameter xOptions.
  74                   */
  75                  [in] com::sun::star::beans::XPropertySet xOptions
  76             );
  77
  78             long getMySecondValue(
  79                  /** Parameters:
  80                      You could insert further arguments after the
  81                      parameter xOptions.
  82                   */
  83                  [in] com::sun::star::beans::XPropertySet xOptions,
  84                  [in] long intDummy
  85             );
  86        };
  87
  88        service CalcAddins
  89        {
  90             /** Exported interfaces:
  91                 This is where you put all interfaces that this service exports. The service
  92                 supports its main interface only.
  93              */
  94            interface XCalcAddins;
  95
  96            /** Necessary base service.
  97                All add-ins must implement this service
  98             */
  99            service com::sun::star::sheet::AddIn;
 100        };
 101         };
 102       };
 103     };
 104 };
 105
 106 #endif