/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_KCharacterType_idl__
#define __com_sun_star_i18n_KCharacterType_idl__

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

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

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

/**
    Constants to identify the character type.
    
    <p> Returned by
    <member>XCharacterClassification::getCharacterType()</member> and
    <member>XCharacterClassification::getStringType()</member> </p>
 */

published constants KCharacterType
{
    /// digit
    const long DIGIT      = 0x00000001;
    
    /// upper case alpha letter
    const long UPPER      = 0x00000002;
    
    /// lower case alpha letter
    const long LOWER      = 0x00000004;
    
    /// title case alpha letter
    const long TITLE_CASE = 0x00000008;
    
    /// any alpha, ALPHA = UPPER | LOWER | TITLE_CASE
    const long ALPHA      = 0x0000000E;
    
    /// control character
    const long CONTROL    = 0x00000010;
    
    /// printable character
    const long PRINTABLE  = 0x00000020;
    
    /// base form
    const long BASE_FORM  = 0x00000040;
    
    /** any <type>UnicodeType</type>::..._LETTER.
        Note that a LETTER must not necessarily be ALPHA */
    const long LETTER     = 0x00000080;
};

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

#endif
