1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_i18n_FormatElement_idl__ 28#define __com_sun_star_i18n_FormatElement_idl__ 29 30//============================================================================ 31 32module com { module sun { module star { module i18n { 33 34//============================================================================ 35 36/** 37 One number format code and its attributes, returned in a sequence by 38 <member>XLocaleData::getAllFormats()</member>. 39 40 <p> Contains raw data defined in the XML locale data files. </p> 41 42 @see XLocaleData 43 for links to DTD of XML locale data files. 44 */ 45 46published struct FormatElement 47{ 48 /** The format code, for example, "YYYY-MM-DD". */ 49 string formatCode; 50 51 /** A name or description that is displayed in the number formatter 52 dialog. */ 53 string formatName; 54 55 /** A unique (within one locale) identifier. */ 56 string formatKey; 57 58 /** Type may be one of "short", "medium", "long". */ 59 string formatType; 60 61 /** Usage category, for example, "DATE" or "FIXED_NUMBER", 62 corresponding with <type>KNumberFormatUsage</type> values. */ 63 string formatUsage; 64 65 /** The index used by the number formatter, predefined values 66 corresponding with <type>NumberFormatIndex</type> values. */ 67 short formatIndex; 68 69 /** If a format code is the default code of a <em>formatType</em> 70 group. */ 71 boolean isDefault; 72}; 73 74//============================================================================ 75}; }; }; }; 76 77#endif 78