]> git.saurik.com Git - wxWidgets.git/commitdiff
Update markup support documentation.
authorVadim Zeitlin <vadim@wxwidgets.org>
Sun, 27 Feb 2011 12:48:54 +0000 (12:48 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Sun, 27 Feb 2011 12:48:54 +0000 (12:48 +0000)
Mention that wxButton and wxStaticText now support markup in all major ports
(using the generic version of the latter under MSW).

Also mention markup changes in the change log.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@67070 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/changes.txt
interface/wx/control.h

index 421b92db464fb0b6a82486b1f9cb8ce8ae2e964a..bd76b95df21fe528de5be5392337e97ee20b6fb9 100644 (file)
@@ -441,6 +441,7 @@ Unix:
 
 All (GUI):
 
+- Implement support for markup in wxButton and wxStaticText.
 - Added wxRichMessageDialog (Rickard Westerlund, GSoC 2010 project).
 - Added wxCommandLinkButton (Rickard Westerlund, GSoC 2010 project).
 - Added wxUIActionSimulator (Steven Lamerton, GSoC 2010 project).
index b7792221df222f201a477dbb572140d34b60a90f..3d35e699520151c82961e2bd1856f5b6c768dd53 100644 (file)
@@ -146,10 +146,9 @@ public:
         Sets the controls label to a string using markup.
 
         Simple markup supported by this function can be used to apply different
-        fonts or colours to different parts of the control label when supported
-        (currently only wxStaticText under GTK+ 2). If markup is not supported
-        by the control or platform, it is simply stripped and SetLabel() is
-        used with the resulting string.
+        fonts or colours to different parts of the control label when supported.
+        If markup is not supported by the control or platform, it is simply
+        stripped and SetLabel() is used with the resulting string.
 
         For example,
         @code
@@ -284,15 +283,22 @@ public:
 
 
         @param markup
-            String containing markup for the label. It may contain newline
-            characters and the markup tags described above.
+            String containing markup for the label. It may contain markup tags
+            described above and newline characters but currently only wxGTK and
+            wxOSX support multiline labels with markup, the generic
+            implementation (also used in wxMSW) only handles single line markup
+            labels. Notice that the string must be well-formed (e.g. all tags
+            must be correctly closed) and won't be shown at all otherwise.
         @return
             @true if the new label was set (even if markup in it was ignored)
             or @false if we failed to parse the markup. In this case the label
             remains unchanged.
 
-        Note that the string must be well-formed (e.g. all tags must be correctly
-        closed) and won't be shown at all otherwise.
+
+        Currently wxButton supports markup in all major ports (wxMSW, wxGTK and
+        wxOSX/Cocoa) while wxStaticText supports it in wxGTK and wxOSX and its
+        generic version (which can be used under MSW if markup support is
+        required). Extending support to more controls is planned in the future.
 
         @since 2.9.2
     */