textserver.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef TEXTSERVER_H
#define TEXTSERVER_H

#include <base_utils/Mem.h>

#include <textsrv/libtextsrv_exports.h>

#define TC_TRANSLATIONSTATUS_master       'M'

#define TC_TRANSLATIONSTATUS_approved     'A'

#define TC_TRANSLATIONSTATUS_pending      'P'

#define TC_TRANSLATIONSTATUS_in_review    'R'

#define TC_TRANSLATIONSTATUS_invalid      'I'

#define TC_TRANSLATIONSTATUS_ghost        'G'

typedef void* txt_t;            

#ifdef __cplusplus
 extern "C"{
#endif

     extern TEXTSRV_API int TXTSRV_get_substituted_text_resource( 
         const char* key,                  
         const char* parameter_1,          
         const char* parameter_2,          
         const char* parameter_3,          
         const char* parameter_4,          
         const char* parameter_5,          
         const char* parameter_6,          
         const char* parameter_7,          
         char** substituted_text_resource  
         );
         
     extern TEXTSRV_API int TXTSRV_get_unsubstituted_text_resource( 
         const char* key,                  
         char** substituted_text_resource  
         );
         

     extern TEXTSRV_API txt_t txt_ctor(
         const char*
         );
     
     extern TEXTSRV_API void txt_destructor(
         txt_t               ts
         );
     
     extern TEXTSRV_API char* txt_subText(
         txt_t,
         const char*,
         int,
         const char*          s1,
         const char*          s2,
         const char*          s3,
         const char*          s4,
         const char*          s5
         );
     
     extern TEXTSRV_API char*  txt_noSubText(
         txt_t,
         const char*,
         int
         );
     
         
     extern TEXTSRV_API char* TC_text(
         const char*          key
         );
     
     extern TEXTSRV_API char* TC_text_arg(
         const char *  key,
         const char * arg
         );
     
     extern TEXTSRV_API char* TC_text_required(
         const char*          key
         );
     
     extern TEXTSRV_API char* TC_product_text(
         const char*          key
         );
     
     extern TEXTSRV_API char* TC_unsubst_text(
         const char*          key
         );
     
     extern TEXTSRV_API char* TC_hier_text(
         const char*          hierarchy_name,
         const char*          key
         );
     
     extern TEXTSRV_API int TC_text_get_locales_check_message (
        char** warning_message   
        );
     
     extern TEXTSRV_API int TC_text_get_current_W3C_locale (
         char** current_w3_locale  
         );
     
     extern TEXTSRV_API int TC_text_get_current_Java_locale (
         char** current_java_locale  
         );
         
    extern TEXTSRV_API int TXTSRV_get_localized_property_value_display_languages (
        int* nb_of_languages,          
        char*** language_code_list,    
        char*** language_name_list     
        );
    
    extern TEXTSRV_API int TXTSRV_get_localized_property_value_entry_language (
        char** language_code, 
        char** language_name  
        );


    extern TEXTSRV_API int TXTSRV_get_search_language (
        char** language_code, 
        char** language_name  
        );


    extern TEXTSRV_API int TXTSRV_get_supported_languages_list (
        int* nb_of_languages,       
        char*** language_code_list, 
        char*** language_name_list  
        );

    extern TEXTSRV_API int TXTSRV_get_localized_languages_list (
        int* nb_of_languages,       
        char*** language_code_list, 
        char*** language_name_list  
        );

    extern TEXTSRV_API int TXTSRV_getTranslationStatusNameAndDescription (
        char translation_status_code,         
        char** translation_status_name,       
        char** translation_status_description 
        );
    
    extern TEXTSRV_API int TXTSRV_getAllTranslationStatusNamesAndDescriptions (
        int* number_of_statuses,                 
        char*** translation_status_names,        
        char*** translation_status_descriptions  
        ); 
    
    extern TEXTSRV_API int TXTSRV_getAllTranslationStatusCodesNamesAndDescriptions (
        int* number_of_statuses,                 
        char** translation_status_codes,         
        char*** translation_status_names,        
        char*** translation_status_descriptions  
        );

    extern TEXTSRV_API int TXTSRV_convertStatusFromStringToCode (
        char* translation_status_name, 
        char* translation_status_code  
        );


    extern TEXTSRV_API int TXTSRV_convertStatusFromCodeToString(
        char translation_status_code,   
        char** translation_status_name  
    );

    extern TEXTSRV_API int TXTSRV_get_site_master_language (
        char** language_code, 
        char** language_name  
    );

#ifdef __cplusplus
}
#endif


#define TC_free_text MEM_free

#define txt_text(ts,keyStr) txt_noSubText(ts, keyStr, 0)

#define txt_texts(ts,keyStr,subStr) txt_subText(ts, keyStr, 0, subStr, NULL, NULL, NULL, NULL)

#include <textsrv/libtextsrv_undef.h>
#endif