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