/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: NumberFormatCode.idl,v $
 * $Revision: 1.6 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_i18n_NumberFormatCode_idl__
#define __com_sun_star_i18n_NumberFormatCode_idl__

//=============================================================================

module com {  module sun {  module star {  module i18n {

//=============================================================================

/**
    Number format code information returned by various
    <type>XNumberFormatCode</type> methods.
 */

published struct NumberFormatCode
{
    /// One of <type>KNumberFormatType</type> values.
    short Type;
    /// One of <type>KNumberFormatUsage</type> values.
    short Usage;
    /// Format code, for example, "YYYY-MM-DD".
    string Code;
    /// Descriptive name of the format for this locale.
    string DefaultName;
    /// Message identifier to be used if the name of the format is localized.
    string NameID;
    /// Index of the code as defined in <type>NumberFormatIndex</type>.
    short Index;
    /// If this format is the default format of the <em>Usage</em> group.
    boolean Default;
};

//=============================================================================
}; }; }; };

#endif