1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_document_XDocumentInfo_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_document_XDocumentInfo_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_ArrayIndexOutOfBoundsException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/ArrayIndexOutOfBoundsException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module document { 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski//============================================================================= 39*b1cdbd2cSJim Jagielski/** provides access to the user fields for the information regarding the 40*b1cdbd2cSJim Jagielski document 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski <p> 43*b1cdbd2cSJim Jagielski These fields are special one of the set of available document properties. 44*b1cdbd2cSJim Jagielski Other ones are accessed as properties (by using the interface 45*b1cdbd2cSJim Jagielski <type scope="com::sun::star::beans">XPropertySet</type>) of service 46*b1cdbd2cSJim Jagielski <type>DocumentInfo</type>. 47*b1cdbd2cSJim Jagielski </p> 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski @deprecated Use <type>XDocumentProperties</type> instead. 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski @see DocumentInfo 52*b1cdbd2cSJim Jagielski @see StandaloneDocumentInfo 53*b1cdbd2cSJim Jagielski @see com::sun::star::beans::XPropertySet 54*b1cdbd2cSJim Jagielski */ 55*b1cdbd2cSJim Jagielskipublished interface XDocumentInfo: com::sun::star::uno::XInterface 56*b1cdbd2cSJim Jagielski{ 57*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 58*b1cdbd2cSJim Jagielski /** provides information about count of available fields 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski <p> 61*b1cdbd2cSJim Jagielski This count marks the top range of possible requests for get/set 62*b1cdbd2cSJim Jagielski any of these fields. Range = [0..count-1] 63*b1cdbd2cSJim Jagielski </p> 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski @returns 66*b1cdbd2cSJim Jagielski current count 67*b1cdbd2cSJim Jagielski */ 68*b1cdbd2cSJim Jagielski short getUserFieldCount(); 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 71*b1cdbd2cSJim Jagielski /** returns the name of an user field 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski @param Index 74*b1cdbd2cSJim Jagielski specifies the position of requested field 75*b1cdbd2cSJim Jagielski Range = [0..count-1] 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski @returns 78*b1cdbd2cSJim Jagielski the name of the requested field 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::ArrayIndexOutOfBoundsException 81*b1cdbd2cSJim Jagielski if <var>Index</var> don't fit range of [0..count-1] 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski string getUserFieldName( [in] short Index ) 84*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::ArrayIndexOutOfBoundsException ); 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 87*b1cdbd2cSJim Jagielski /** returns the value of an user field 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski @param Index 90*b1cdbd2cSJim Jagielski specifies the position of requested field 91*b1cdbd2cSJim Jagielski Range = [0..count-1] 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski @returns 94*b1cdbd2cSJim Jagielski the value of the requested field 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::ArrayIndexOutOfBoundsException 97*b1cdbd2cSJim Jagielski if <var>Index</var> don't fit range of [0..count-1] 98*b1cdbd2cSJim Jagielski */ 99*b1cdbd2cSJim Jagielski string getUserFieldValue( [in] short Index ) 100*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::ArrayIndexOutOfBoundsException ); 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 103*b1cdbd2cSJim Jagielski /** changes the name of one of the user fields 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski @param Index 106*b1cdbd2cSJim Jagielski specifies the position of requested field 107*b1cdbd2cSJim Jagielski Range = [0..count-1] 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski @param Name 110*b1cdbd2cSJim Jagielski the new name for this field to be set 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::ArrayIndexOutOfBoundsException 113*b1cdbd2cSJim Jagielski if <var>Index</var> don't fit range of [0..count-1] 114*b1cdbd2cSJim Jagielski */ 115*b1cdbd2cSJim Jagielski void setUserFieldName( 116*b1cdbd2cSJim Jagielski [in] short Index , 117*b1cdbd2cSJim Jagielski [in] string Name ) 118*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::ArrayIndexOutOfBoundsException ); 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 121*b1cdbd2cSJim Jagielski /** changes the value of one of the user fields 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski @param Index 124*b1cdbd2cSJim Jagielski specifies the position of requested field 125*b1cdbd2cSJim Jagielski Range = [0..count-1] 126*b1cdbd2cSJim Jagielski 127*b1cdbd2cSJim Jagielski @param Value 128*b1cdbd2cSJim Jagielski the new value for this field to be set 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::ArrayIndexOutOfBoundsException 131*b1cdbd2cSJim Jagielski if <var>Index</var> don't fit range of [0..count-1] 132*b1cdbd2cSJim Jagielski */ 133*b1cdbd2cSJim Jagielski void setUserFieldValue( 134*b1cdbd2cSJim Jagielski [in] short Index , 135*b1cdbd2cSJim Jagielski [in] string Value ) 136*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::ArrayIndexOutOfBoundsException ); 137*b1cdbd2cSJim Jagielski}; 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski//============================================================================= 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski}; }; }; }; 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski#endif 144