summaryrefslogtreecommitdiff
path: root/doc/base/classes.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2017-08-16 17:59:04 +0200
committerRémi Verschelde <rverschelde@gmail.com>2017-08-17 18:10:22 +0200
commitc72529baf09927b381e7850a0f132c1473b16ee2 (patch)
treeda64b9684d3db8cce6b50a20a50da2e1d99230bc /doc/base/classes.xml
parent5485233549c97c7128fc2026bc2c01d3c1c5b48d (diff)
Rename `XL_MESSAGE` aka `tr` to `localize`
Also renames `set_message_translation` to `set_message_localization` for consistency.
Diffstat (limited to 'doc/base/classes.xml')
-rw-r--r--doc/base/classes.xml31
1 files changed, 11 insertions, 20 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index e9902badea..418739aa3d 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -28002,15 +28002,6 @@
Objects also receive notifications ([method _notification]). Notifications are a simple way to notify the object about simple events, so they can all be handled together.
</description>
<methods>
- <method name="XL_MESSAGE" qualifiers="const">
- <return type="String">
- </return>
- <argument index="0" name="message" type="String">
- </argument>
- <description>
- Deprecated, will go away.
- </description>
- </method>
<method name="_get" qualifiers="virtual">
<argument index="0" name="property" type="String">
</argument>
@@ -28268,6 +28259,15 @@
<description>
</description>
</method>
+ <method name="localize" qualifiers="const">
+ <return type="String">
+ </return>
+ <argument index="0" name="message" type="String">
+ </argument>
+ <description>
+ Localize (translate) a message. Only works if message localization is enabled (which it is by default). See [method set_message_localization].
+ </description>
+ </method>
<method name="notification">
<argument index="0" name="what" type="int">
</argument>
@@ -28297,11 +28297,11 @@
If set to true, signal emission is blocked.
</description>
</method>
- <method name="set_message_translation">
+ <method name="set_message_localization">
<argument index="0" name="enable" type="bool">
</argument>
<description>
- Set true if this object can translate strings (in calls to tr() ). Default is true.
+ Define whether this object can localize strings (with calls to [code]localize[/code]). Default is true.
</description>
</method>
<method name="set_meta">
@@ -28320,15 +28320,6 @@
Set a script into the object, scripts extend the object functionality.
</description>
</method>
- <method name="tr" qualifiers="const">
- <return type="String">
- </return>
- <argument index="0" name="message" type="String">
- </argument>
- <description>
- Translate a message. Only works in message translation is enabled (which is by default). See [method set_message_translation].
- </description>
- </method>
</methods>
<signals>
<signal name="script_changed">