Make storing non-trivial data in wxThreadSpecificInfo possible.

[wxWidgets.git] / interface / wx / richtext / richtextbuffer.h

diff --git a/interface/wx/richtext/richtextbuffer.h b/interface/wx/richtext/richtextbuffer.h
index 7c0bc6bd694bb9192642c97c6e0401a06da7693b..2426e696c82fff7543b29a7082e1c518fcaa0e2e 100644 (file)
--- a/interface/wx/richtext/richtextbuffer.h
+++ b/interface/wx/richtext/richtextbuffer.h
@@ -4,7 +4,6 @@
 // Author:      Julian Smart
 // Modified by:
 // Created:     2005-09-30
-// RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
@@ -2085,7 +2084,7 @@ public:
 
     /**
         Lay the item out at the specified position with the given size constraint.
-        Layout must set the cached size. @rect is the available space for the object,
+        Layout must set the cached size. @a rect is the available space for the object,
         and @a parentRect is the container that is used to determine a relative size
         or position (for example if a text box must be 50% of the parent text box).
     */
@@ -3564,7 +3563,7 @@ public:
 
     /**
         Lay the item out at the specified position with the given size constraint.
-        Layout must set the cached size. @rect is the available space for the object,
+        Layout must set the cached size. @a rect is the available space for the object,
         and @a parentRect is the container that is used to determine a relative size
         or position (for example if a text box must be 50% of the parent text box).
     */
@@ -3665,7 +3664,7 @@ public:
     /**
         Constructor, creating a field type definition with a text label.
 
-        @param parent
+        @param name
             The name of the type definition. This must be unique, and is the type
             name used when adding a field to a control.
         @param label
@@ -3681,10 +3680,10 @@ public:
     /**
         Constructor, creating a field type definition with a bitmap label.
 
-        @param parent
+        @param name
             The name of the type definition. This must be unique, and is the type
             name used when adding a field to a control.
-        @param label
+        @param bitmap
             The bitmap label to be shown on the field.
         @param displayStyle
             The display style: one of wxRICHTEXT_FIELD_STYLE_RECTANGLE,
@@ -3729,7 +3728,7 @@ public:
 
     /**
         Lay the item out at the specified position with the given size constraint.
-        Layout must set the cached size. @rect is the available space for the object,
+        Layout must set the cached size. @a rect is the available space for the object,
         and @a parentRect is the container that is used to determine a relative size
         or position (for example if a text box must be 50% of the parent text box).
     */
@@ -5373,7 +5372,14 @@ protected:
 /**
     @class wxRichTextCell
 
-    wxRichTextCell is the cell in a table.
+    wxRichTextCell is the cell in a table, in which the user can type. As well as
+    text, it can also contain objects e.g. an image, or even another wxRichTextTable.
+    
+    A cell's appearance can be changed via its associated wxRichTextAttr; for example
+    its size altered or its background colour set. It also has the properties of
+    column- and row-span. By default these are 1, meaning that the cell only spans
+    itself, but can be increased using the SetColspan() and SetRowspan() methods.
+    Attempts to set too large a span are silently truncated to the table edge.
  */
 
 class wxRichTextCell: public wxRichTextBox
@@ -5407,6 +5413,52 @@ public:
 
 // Accessors
 
+    /**
+        Returns the number of columns spanned by the cell.
+        
+        By default a cell doesn't span extra columns, so this function returns 1.
+        
+        @since 2.9.5
+        
+        @see SetColspan(), GetRowspan()
+    */
+    int GetColspan() const;
+
+    /**
+        Set the number of columns spanned by the cell.
+        
+        By default colspan is 1 i.e. a cell doesn't span extra columns. Pass a value >1
+        to change this. Attempting to set a colspan <1 will assert and be ignored.
+        
+        @since 2.9.5
+        
+        @see GetColspan(), SetRowspan()
+    */
+    void SetColspan(long span);
+
+    /**
+        Returns the number of rows spanned by the cell.
+        
+        By default a cell doesn't span extra rows, so this function returns 1.
+        
+        @since 2.9.5
+        
+        @see SetRowspan(), GetColspan()
+    */
+    int GetRowspan() const;
+
+    /**
+        Set the number of rows spanned by the cell.
+        
+        By default colspan is 1 i.e. a cell doesn't span extra rows. Pass a value >1
+        to change this. Attempting to set a rowspan <1 will assert and be ignored.
+        
+        @since 2.9.5
+        
+        @see GetRowspan(), SetColspan()
+    */
+    void SetRowspan(long span);
+
 // Operations
 
     virtual wxRichTextObject* Clone() const { return new wxRichTextCell(*this); }