xref: /aoo42x/main/odk/examples/java/Spreadsheet/XCalcAddins.idl (revision cdf0e10c)

/*************************************************************************
 *
 *  The Contents of this file are made available subject to the terms of
 *  the BSD license.
 *
 *  Copyright 2000, 2010 Oracle and/or its affiliates.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *************************************************************************/
#ifndef INCLUDED_ORG_OPENOFFICE_SHEET_ADDIN_XCALCADDIN_IDL
#define INCLUDED_ORG_OPENOFFICE_SHEET_ADDIN_XCALCADDIN_IDL

#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/sheet/AddIn.idl>


module org {
  module openoffice {
      module sheet {
        module addin {
	  /** Interface with your additional methods.

              You may declare several methods. Each method may have
              any number of arguments after xOptions.
              Furthermore, you could replace the name of the service and
              the interface, but only if you want to replace this name in all
              your project files. This example will work with tNeccessaryhe default
              names.
              Interface names should start with an X prefix.
           */
	  interface XCalcAddins
	  {
            /** Declare your methods:
                This is where you could add the declarations of your methods.
                If you want to learn more about
                the IDL syntax including the base types, you could
                visit the following web page:
                http://www.openoffice.org/project/udk/common/man/idl_syntax.html .
             */
            long getMyFirstValue(
                 /** Parameters:
                     You could insert further arguments after the
                     parameter xOptions.
                  */
                 [in] com::sun::star::beans::XPropertySet xOptions
            );

            long getMySecondValue(
                 /** Parameters:
                     You could insert further arguments after the
                     parameter xOptions.
                  */
                 [in] com::sun::star::beans::XPropertySet xOptions,
                 [in] long intDummy
            );
       };

       service CalcAddins
	   {
            /** Exported interfaces:
                This is where you put all interfaces that this service exports. The service
                supports its main interface only.
             */
           interface XCalcAddins;

           /** Necessary base service.
               All add-ins must implement this service
            */
           service com::sun::star::sheet::AddIn;
       };
        };
      };
    };
};

#endif