offapi/com/sun/star/document/XDocumentInfo.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: XDocumentInfo.idl,v $
  10  * $Revision: 1.10 $
  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 #ifndef __com_sun_star_document_XDocumentInfo_idl__
  31 #define __com_sun_star_document_XDocumentInfo_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_ArrayIndexOutOfBoundsException_idl__
  38 #include <com/sun/star/lang/ArrayIndexOutOfBoundsException.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {   module sun {   module star {   module document {
  44
  45 //=============================================================================
  46 /** provides access to the user fields for the information regarding the
  47     document
  48
  49     <p>
  50     These fields are special one of the set of available document properties.
  51     Other ones are accessed as properties (by using the interface
  52     <type scope="com::sun::star::beans">XPropertySet</type>) of service
  53     <type>DocumentInfo</type>.
  54     </p>
  55
  56     @deprecated     Use <type>XDocumentProperties</type> instead.
  57
  58     @see DocumentInfo
  59     @see StandaloneDocumentInfo
  60     @see com::sun::star::beans::XPropertySet
  61  */
  62 published interface XDocumentInfo: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65     /** provides information about count of available fields
  66
  67         <p>
  68         This count marks the top range of possible requests for get/set
  69         any of these fields. Range = [0..count-1]
  70         </p>
  71
  72         @returns
  73             current count
  74      */
  75     short getUserFieldCount();
  76
  77     //-------------------------------------------------------------------------
  78     /** returns the name of an user field
  79
  80         @param Index
  81             specifies the position of requested field
  82             Range = [0..count-1]
  83
  84         @returns
  85             the name of the requested field
  86
  87         @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
  88             if <var>Index</var> don't fit range of [0..count-1]
  89      */
  90     string getUserFieldName( [in] short Index )
  91         raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
  92
  93     //-------------------------------------------------------------------------
  94     /** returns the value of an user field
  95
  96         @param Index
  97             specifies the position of requested field
  98             Range = [0..count-1]
  99
 100         @returns
 101             the value of the requested field
 102
 103         @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
 104             if <var>Index</var> don't fit range of [0..count-1]
 105      */
 106     string getUserFieldValue( [in] short Index )
 107         raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
 108
 109     //-------------------------------------------------------------------------
 110     /** changes the name of one of the user fields
 111
 112         @param Index
 113             specifies the position of requested field
 114             Range = [0..count-1]
 115
 116         @param Name
 117             the new name for this field to be set
 118
 119         @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
 120             if <var>Index</var> don't fit range of [0..count-1]
 121      */
 122     void setUserFieldName(
 123         [in] short  Index ,
 124         [in] string Name  )
 125             raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
 126
 127     //-------------------------------------------------------------------------
 128     /** changes the value of one of the user fields
 129
 130         @param Index
 131             specifies the position of requested field
 132             Range = [0..count-1]
 133
 134         @param Value
 135             the new value for this field to be set
 136
 137         @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
 138             if <var>Index</var> don't fit range of [0..count-1]
 139      */
 140     void setUserFieldValue(
 141         [in] short  Index ,
 142         [in] string Value )
 143             raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
 144 };
 145
 146 //=============================================================================
 147
 148 }; }; }; };
 149
 150 #endif