Removing more CodeWarrior project files.

[wxWidgets.git] / interface / wx / intl.h

diff --git a/interface/wx/intl.h b/interface/wx/intl.h
index e0d3d4899a7ca320f38629658947b5d74eaf9cd6..6940db777983a17cfc1669a68be6d1a6db9d91a2 100644 (file)
--- a/interface/wx/intl.h
+++ b/interface/wx/intl.h
@@ -17,7 +17,7 @@
 */
 enum wxLanguage
 {
 */
 enum wxLanguage
 {

-    /// User's default/preffered language as got from OS.
+    /// User's default/preferred language as got from OS.

     wxLANGUAGE_DEFAULT,
 
     /// Unknown language, returned if wxLocale::GetSystemLanguage fails.
     wxLANGUAGE_DEFAULT,
 
     /// Unknown language, returned if wxLocale::GetSystemLanguage fails.


@@ -263,28 +263,50 @@ enum wxLanguage
 
 
 /**
 
 
 /**

-    wxLanguageInfo: encapsulates wxLanguage to OS native lang.desc.
+    This is the layout direction stored in wxLanguageInfo and returned by
+    wxApp::GetLayoutDirection(), wxWindow::GetLayoutDirection(),
+    wxDC::GetLayoutDirection() for RTL (right-to-left) languages support.
+*/
+enum wxLayoutDirection
+{
+    wxLayout_Default,
+    wxLayout_LeftToRight,
+    wxLayout_RightToLeft
+};
+
+/**
+    Encapsulates ::wxLanguage in a OS native lang.desc.

                     translation information
 */
 struct WXDLLIMPEXP_BASE wxLanguageInfo
 {
                     translation information
 */
 struct WXDLLIMPEXP_BASE wxLanguageInfo
 {

-    /// wxLanguage id. It should be greater than wxLANGUAGE_USER_DEFINED.
+    /// ::wxLanguage id. It should be greater than @c wxLANGUAGE_USER_DEFINED.

     int Language;
     int Language;

-    wxString CanonicalName;         //!< Canonical name, e.g. fr_FR.
-#ifdef __WXMSW__
-    wxUint32 WinLang,               //!< Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
-             WinSublang;
-#endif // __WXMSW__
-    wxString Description;           //!< Human-readable name of the language.
+
+    /// Canonical name of the language, e.g. @c fr_FR.
+    wxString CanonicalName;
+
+    //@{
+    /**
+        Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
+
+        @onlyfor{wxmsw}
+    */
+    wxUint32 WinLang, WinSublang;
+    //@}
+
+    /// Human-readable name of the language.
+    wxString Description;
+
+    /// The layout direction used for this language.

     wxLayoutDirection LayoutDirection;
 
     wxLayoutDirection LayoutDirection;
 

-#ifdef __WXMSW__

     /// Return the LCID corresponding to this language.
     /// Return the LCID corresponding to this language.

+    /// @onlyfor{wxmsw}

     wxUint32 GetLCID() const;
     wxUint32 GetLCID() const;

-#endif // __WXMSW__

 
     /// Return the locale name corresponding to this language usable with
 
     /// Return the locale name corresponding to this language usable with

-    /// setlocale() on the current system
+    /// @c setlocale() on the current system.

     wxString GetLocaleName() const;
 };
 
     wxString GetLocaleName() const;
 };
 


@@ -339,7 +361,7 @@ struct WXDLLIMPEXP_BASE wxLanguageInfo
     @endWxPerlOnly
 
     @library{wxbase}
     @endWxPerlOnly
 
     @library{wxbase}

-    @category{misc}
+    @category{cfg}

 
     @see @ref overview_i18n, @ref page_samples_internat, wxXLocale
 */
 
     @see @ref overview_i18n, @ref page_samples_internat, wxXLocale
 */


@@ -381,7 +403,6 @@ public:
     */
     virtual ~wxLocale();
 
     */
     virtual ~wxLocale();
 

-    //@{

     /**
         Add a catalog for use with the current locale: it is searched for in standard
         places (current directory first, then the system one), but you may also prepend
     /**
         Add a catalog for use with the current locale: it is searched for in standard
         places (current directory first, then the system one), but you may also prepend


@@ -390,33 +411,50 @@ public:
         All loaded catalogs will be used for message lookup by GetString() for
         the current locale.
 
         All loaded catalogs will be used for message lookup by GetString() for
         the current locale.
 

-        Returns @true if catalog was successfully loaded, @false otherwise (which might
-        mean that the catalog is not found or that it isn't in the correct format).
-
-        The second form of this method takes two additional arguments,
-        @a msgIdLanguage and @a msgIdCharset.
-
-        @a msgIdLanguage specifies the language of "msgid" strings in source code
-        (i.e. arguments to GetString(), wxGetTranslation() and the _() macro).
-        It is used if AddCatalog() cannot find any catalog for current language:
-        if the language is same as source code language, then strings from source
-        code are used instead.
-
-        @a msgIdCharset lets you specify the charset used for msgids in sources
-        in case they use 8-bit characters (e.g. German or French strings).
-        This argument has no effect in Unicode build, because literals in sources are
-        Unicode strings; you have to use compiler-specific method of setting the right
-        charset when compiling with Unicode.
-
-        By default (i.e. when you use the first form), msgid strings are assumed
+        In this overload, @c msgid strings are assumed

         to be in English and written only using 7-bit ASCII characters.
         If you have to deal with non-English strings or 8-bit characters in the
         source code, see the instructions in @ref overview_nonenglish.
         to be in English and written only using 7-bit ASCII characters.
         If you have to deal with non-English strings or 8-bit characters in the
         source code, see the instructions in @ref overview_nonenglish.

+
+        @return
+            @true if catalog was successfully loaded, @false otherwise (which might
+            mean that the catalog is not found or that it isn't in the correct format).

     */
     bool AddCatalog(const wxString& domain);
     */
     bool AddCatalog(const wxString& domain);

+
+    /**
+        Add a catalog for use with the current locale: it is searched for in standard
+        places (current directory first, then the system one), but you may also prepend
+        additional directories to the search path with AddCatalogLookupPathPrefix().
+
+        All loaded catalogs will be used for message lookup by GetString() for
+        the current locale.
+
+        This overload takes two additional arguments, @a msgIdLanguage and @a msgIdCharset.
+
+        @param domain
+            The catalog domain to add.
+
+        @param msgIdLanguage
+            Specifies the language of "msgid" strings in source code
+            (i.e. arguments to GetString(), wxGetTranslation() and the _() macro).
+            It is used if AddCatalog() cannot find any catalog for current language:
+            if the language is same as source code language, then strings from source
+            code are used instead.
+
+        @param msgIdCharset
+            Lets you specify the charset used for msgids in sources
+            in case they use 8-bit characters (e.g. German or French strings).
+            This argument has no effect in Unicode build, because literals in sources are
+            Unicode strings; you have to use compiler-specific method of setting the right
+            charset when compiling with Unicode.
+
+        @return
+            @true if catalog was successfully loaded, @false otherwise (which might
+            mean that the catalog is not found or that it isn't in the correct format).
+    */

     bool AddCatalog(const wxString& domain, wxLanguage msgIdLanguage,
                     const wxString& msgIdCharset);
     bool AddCatalog(const wxString& domain, wxLanguage msgIdLanguage,
                     const wxString& msgIdCharset);

-    //@}

 
     /**
         Add a prefix to the catalog lookup path: the message catalog files will
 
     /**
         Add a prefix to the catalog lookup path: the message catalog files will


@@ -445,7 +483,7 @@ public:
 
         @see GetLanguageInfo()
     */
 
         @see GetLanguageInfo()
     */

-    static wxLanguageInfo* FindLanguageInfo(const wxString& locale);
+    static const wxLanguageInfo* FindLanguageInfo(const wxString& locale);

 
     /**
         Returns the canonical form of current locale name. Canonical form is the
 
     /**
         Returns the canonical form of current locale name. Canonical form is the


@@ -469,10 +507,10 @@ public:
                             const wxString& domain = wxEmptyString) const;
 
     /**
                             const wxString& domain = wxEmptyString) const;
 
     /**

-        Returns wxLanguage() constant of current language.
+        Returns the ::wxLanguage constant of current language.

 
         Note that you can call this function only if you used the form of
 
         Note that you can call this function only if you used the form of

-        Init() that takes wxLanguage argument.
+        Init() that takes ::wxLanguage argument.

     */
     int GetLanguage() const;
 
     */
     int GetLanguage() const;
 


@@ -486,7 +524,7 @@ public:
         as an argument to this function and in this case the result of
         GetSystemLanguage() is used.
     */
         as an argument to this function and in this case the result of
         GetSystemLanguage() is used.
     */

-    static wxLanguageInfo* GetLanguageInfo(int lang) const;
+    static const wxLanguageInfo* GetLanguageInfo(int lang);

 
     /**
         Returns English name of the given language or empty string if this
 
     /**
         Returns English name of the given language or empty string if this


@@ -494,7 +532,7 @@ public:
 
         See GetLanguageInfo() for a remark about special meaning of @c wxLANGUAGE_DEFAULT.
     */
 
         See GetLanguageInfo() for a remark about special meaning of @c wxLANGUAGE_DEFAULT.
     */

-    static wxString GetLanguageName(int lang) const;
+    static wxString GetLanguageName(int lang);

 
     /**
         Returns the locale name as passed to the constructor or Init().
 
     /**
         Returns the locale name as passed to the constructor or Init().


@@ -520,8 +558,8 @@ public:
         @remarks Domains are searched in the last to first order, i.e. catalogs
                  added later override those added before.
     */
         @remarks Domains are searched in the last to first order, i.e. catalogs
                  added later override those added before.
     */

-    const wxString& GetString(const wxString& origString,
-                              const wxString& domain = wxEmptyString) const;
+    virtual const wxString& GetString(const wxString& origString,
+                                      const wxString& domain = wxEmptyString) const;

 
     /**
         Retrieves the translation for a string in all loaded domains unless the @a domain
 
     /**
         Retrieves the translation for a string in all loaded domains unless the @a domain


@@ -550,10 +588,9 @@ public:
         @remarks Domains are searched in the last to first order, i.e. catalogs
                  added later override those added before.
     */
         @remarks Domains are searched in the last to first order, i.e. catalogs
                  added later override those added before.
     */

-    const wxString& GetString(const wxString& origString,
-                              const wxString& origString2,
-                              size_t n,
-                              const wxString& domain = wxEmptyString) const;
+    virtual const wxString& GetString(const wxString& origString,
+                                      const wxString& origString2, size_t n,
+                                      const wxString& domain = wxEmptyString) const;

 
     /**
         Returns current platform-specific locale name as passed to setlocale().
 
     /**
         Returns current platform-specific locale name as passed to setlocale().


@@ -566,7 +603,7 @@ public:
         Returns wxFontEncoding() value or @c wxFONTENCODING_SYSTEM if it
         couldn't be determined.
     */
         Returns wxFontEncoding() value or @c wxFONTENCODING_SYSTEM if it
         couldn't be determined.
     */

-    static wxFontEncoding GetSystemEncoding() const;
+    static wxFontEncoding GetSystemEncoding();

 
     /**
         Tries to detect the name of the user's default font encoding.
 
     /**
         Tries to detect the name of the user's default font encoding.


@@ -576,14 +613,14 @@ public:
         Returns a user-readable string value or an empty string if it couldn't be
         determined.
     */
         Returns a user-readable string value or an empty string if it couldn't be
         determined.
     */

-    static wxString GetSystemEncodingName() const;
+    static wxString GetSystemEncodingName();

 
     /**
         Tries to detect the user's default language setting.
 
     /**
         Tries to detect the user's default language setting.

-        Returns wxLanguage value or @b wxLANGUAGE_UNKNOWN if the language-guessing
+        Returns the ::wxLanguage value or @b wxLANGUAGE_UNKNOWN if the language-guessing

         algorithm failed.
     */
         algorithm failed.
     */

-    static int GetSystemLanguage() const;
+    static int GetSystemLanguage();

 
     /**
         Initializes the wxLocale instance.
 
     /**
         Initializes the wxLocale instance.


@@ -597,7 +634,7 @@ public:
         try to translate the messages using the message catalogs for this locale.
 
         @param language
         try to translate the messages using the message catalogs for this locale.
 
         @param language

-            wxLanguage identifier of the locale.
+            ::wxLanguage identifier of the locale.

             @c wxLANGUAGE_DEFAULT has special meaning -- wxLocale will use system's
             default language (see GetSystemLanguage()).
         @param flags
             @c wxLANGUAGE_DEFAULT has special meaning -- wxLocale will use system's
             default language (see GetSystemLanguage()).
         @param flags


@@ -640,10 +677,8 @@ public:
             and windows-1250.
             See @ref overview_nonenglish for detailed description of this behaviour.
     */
             and windows-1250.
             See @ref overview_nonenglish for detailed description of this behaviour.
     */

-    bool Init(const wxString& name,
-              const wxString& short = wxEmptyString,
-              const wxString& locale = wxEmptyString,
-              bool bLoadDefault = true,
+    bool Init(const wxString& name, const wxString& short = wxEmptyString,
+              const wxString& locale = wxEmptyString, bool bLoadDefault = true,

               bool bConvertEncoding = false);
 
     /**
               bool bConvertEncoding = false);
 
     /**


@@ -651,11 +686,11 @@ public:
         this locale. For example in Windows 2000 and Windows XP, support for many
         locales is not installed by default. Returns @true if the locale is
         supported.
         this locale. For example in Windows 2000 and Windows XP, support for many
         locales is not installed by default. Returns @true if the locale is
         supported.

-        The argument @a lang is the wxLanguage identifier. To obtain this for a
-        given a two letter ISO language code, use
-        FindLanguageInfo() to obtain its
-        wxLanguageInfo structure. See AddLanguage() for
-        the wxLanguageInfo description.
+
+        The argument @a lang is the ::wxLanguage identifier. To obtain this for a
+        given a two letter ISO language code, use FindLanguageInfo() to obtain its
+        wxLanguageInfo structure.
+        See AddLanguage() for the wxLanguageInfo description.

 
         @since 2.7.1.
     */
 
         @since 2.7.1.
     */


@@ -669,7 +704,7 @@ public:
 
         @see AddCatalog()
     */
 
         @see AddCatalog()
     */

-    bool IsLoaded(const char* domain) const;
+    bool IsLoaded(const wxString& domain) const;

 
     /**
         Returns @true if the locale could be set successfully.
 
     /**
         Returns @true if the locale could be set successfully.


@@ -684,7 +719,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_string */
+/** @addtogroup group_funcmacro_string */

 //@{
 
 /**
 //@{
 
 /**