oovbaapi/ooo/vba/XDocumentProperty.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: XDocument.idl,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef __ooo_vba_XDocumentProperty_idl__
  32 #define __ooo_vba_XDocumentProperty_idl__
  33
  34 #ifndef __com_sun_star_script_BasicErrorException_idl__
  35 #include <com/sun/star/script/BasicErrorException.idl>
  36 #endif
  37 #ifndef __com_sun_star_script_XDefaultProperty_idl__
  38 #include <com/sun/star/script/XDefaultProperty.idl>
  39 #endif
  40 #ifndef __ooo_vba_XHelperInterface_idl__
  41 #include <ooo/vba/XHelperInterface.idl>
  42 #endif
  43
  44 module ooo { module vba {
  45
  46 /**
  47  * Specific built-in document property. Use CustomDocumentProperties(index),
  48  * where index is the name or index number of the custom document property,
  49  * to return a DocumentProperty object that represents a specific custom document property.
  50  */
  51 interface XDocumentProperty
  52 {
  53
  54     interface com::sun::star::script::XDefaultProperty;
  55     interface ooo::vba::XHelperInterface;
  56
  57     void Delete()
  58         raises (com::sun::star::script::BasicErrorException);
  59
  60     /** Required String. The name of the property.
  61      */
  62     string getName()
  63         raises (com::sun::star::script::BasicErrorException);
  64
  65     void setName([in] string Name)
  66         raises (com::sun::star::script::BasicErrorException);
  67
  68     /** The data type of the property.
  69      * Can be one of the following MsoDocProperties constants:
  70      * msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat,
  71      * msoPropertyTypeNumber, or msoPropertyTypeString.
  72      */
  73     byte getType()
  74         raises (com::sun::star::script::BasicErrorException);
  75
  76     void setType([in] byte Type)
  77         raises (com::sun::star::script::BasicErrorException);
  78
  79     /** If true, then LinkSource has a valid value. */
  80     boolean getLinkToContent()
  81         raises (com::sun::star::script::BasicErrorException);
  82
  83     void setLinkToContent([in] boolean LinkToContent)
  84         raises (com::sun::star::script::BasicErrorException);
  85
  86     /** If LinkToContent is false, then this contains the value of the property
  87      * The data type of the value will match the Type property.
  88      */
  89     any getValue()
  90         raises (com::sun::star::script::BasicErrorException);
  91
  92     void setValue([in] any Value)
  93         raises (com::sun::star::script::BasicErrorException);
  94
  95     /** If LinkToContent is false, then this contains the value of the property */
  96     string getLinkSource()
  97         raises (com::sun::star::script::BasicErrorException);
  98
  99     void setLinkSource([in] string LinkSource)
 100         raises (com::sun::star::script::BasicErrorException);
 101 };
 102
 103 }; };
 104
 105 #endif
 106