/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __ooo_vba_XDocumentProperty_idl__
#define __ooo_vba_XDocumentProperty_idl__

#include <com/sun/star/script/BasicErrorException.idl>
#include <com/sun/star/script/XDefaultProperty.idl>
#include <ooo/vba/XHelperInterface.idl>

module ooo { module vba {

/**
 * Specific built-in document property. Use CustomDocumentProperties(index),
 * where index is the name or index number of the custom document property,
 * to return a DocumentProperty object that represents a specific custom document property.
 */
interface XDocumentProperty
{

    interface com::sun::star::script::XDefaultProperty;
    interface ooo::vba::XHelperInterface;

    void Delete()
        raises (com::sun::star::script::BasicErrorException);

    /** Required String. The name of the property.
     */
    string getName()
        raises (com::sun::star::script::BasicErrorException);

    void setName([in] string Name)
        raises (com::sun::star::script::BasicErrorException);

    /** The data type of the property.
     * Can be one of the following MsoDocProperties constants:
     * msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat,
     * msoPropertyTypeNumber, or msoPropertyTypeString.
     */
    byte getType()
        raises (com::sun::star::script::BasicErrorException);

    void setType([in] byte Type)
        raises (com::sun::star::script::BasicErrorException);

    /** If true, then LinkSource has a valid value. */
    boolean getLinkToContent()
        raises (com::sun::star::script::BasicErrorException);

    void setLinkToContent([in] boolean LinkToContent)
        raises (com::sun::star::script::BasicErrorException);

    /** If LinkToContent is false, then this contains the value of the property
     * The data type of the value will match the Type property.
     */
    any getValue()
        raises (com::sun::star::script::BasicErrorException);

    void setValue([in] any Value)
        raises (com::sun::star::script::BasicErrorException);

    /** If LinkToContent is false, then this contains the value of the property */
    string getLinkSource()
        raises (com::sun::star::script::BasicErrorException);

    void setLinkSource([in] string LinkSource)
        raises (com::sun::star::script::BasicErrorException);
};

}; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */