oovbaapi/ooo/vba/XDocumentProperty.idl

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 #ifndef __ooo_vba_XDocumentProperty_idl__
  20 #define __ooo_vba_XDocumentProperty_idl__
  21
  22 #include <com/sun/star/script/BasicErrorException.idl>
  23 #include <com/sun/star/script/XDefaultProperty.idl>
  24 #include <ooo/vba/XHelperInterface.idl>
  25
  26 module ooo { module vba {
  27
  28 /**
  29  * Specific built-in document property. Use CustomDocumentProperties(index),
  30  * where index is the name or index number of the custom document property,
  31  * to return a DocumentProperty object that represents a specific custom document property.
  32  */
  33 interface XDocumentProperty
  34 {
  35
  36     interface com::sun::star::script::XDefaultProperty;
  37     interface ooo::vba::XHelperInterface;
  38
  39     void Delete()
  40         raises (com::sun::star::script::BasicErrorException);
  41
  42     /** Required String. The name of the property.
  43      */
  44     string getName()
  45         raises (com::sun::star::script::BasicErrorException);
  46
  47     void setName([in] string Name)
  48         raises (com::sun::star::script::BasicErrorException);
  49
  50     /** The data type of the property.
  51      * Can be one of the following MsoDocProperties constants:
  52      * msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat,
  53      * msoPropertyTypeNumber, or msoPropertyTypeString.
  54      */
  55     byte getType()
  56         raises (com::sun::star::script::BasicErrorException);
  57
  58     void setType([in] byte Type)
  59         raises (com::sun::star::script::BasicErrorException);
  60
  61     /** If true, then LinkSource has a valid value. */
  62     boolean getLinkToContent()
  63         raises (com::sun::star::script::BasicErrorException);
  64
  65     void setLinkToContent([in] boolean LinkToContent)
  66         raises (com::sun::star::script::BasicErrorException);
  67
  68     /** If LinkToContent is false, then this contains the value of the property
  69      * The data type of the value will match the Type property.
  70      */
  71     any getValue()
  72         raises (com::sun::star::script::BasicErrorException);
  73
  74     void setValue([in] any Value)
  75         raises (com::sun::star::script::BasicErrorException);
  76
  77     /** If LinkToContent is false, then this contains the value of the property */
  78     string getLinkSource()
  79         raises (com::sun::star::script::BasicErrorException);
  80
  81     void setLinkSource([in] string LinkSource)
  82         raises (com::sun::star::script::BasicErrorException);
  83 };
  84
  85 }; };
  86
  87 #endif
  88