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