main/offapi/com/sun/star/i18n/NumberFormatCode.idl

/**************************************************************
 * 
 * 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
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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