]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/statbmp.h
fix reference counting problems with wxGridCellWithAttr (re-#9567)
[wxWidgets.git] / interface / statbmp.h
index f212d85ff0e1fee070b118c30056b0fcc80fe641..dde41369503a09b30d0203393ba50d678409232d 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        statbmp.h
-// Purpose:     documentation for wxStaticBitmap class
+// Purpose:     interface of wxStaticBitmap
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,58 +9,53 @@
 /**
     @class wxStaticBitmap
     @wxheader{statbmp.h}
-    
+
     A static bitmap control displays a bitmap. It is meant for display of the
     small icons in the dialog boxes and is not meant to be a general purpose image
     display control. In particular, under Windows 9x the size of bitmap is limited
     to 64*64 pixels and thus you should use your own control if you want to
     display larger images portably.
-    
+
     @library{wxcore}
     @category{ctrl}
-    @appearance{staticbitmap.png}
-    
-    @seealso
-    wxStaticBitmap, wxStaticBox
+    <!-- @appearance{staticbitmap.png} -->
+
+    @see wxStaticBitmap, wxStaticBox
 */
 class wxStaticBitmap : public wxControl
 {
 public:
-    //@{
     /**
-        Constructor, creating and showing a static bitmap control.
-        
-        @param parent 
-        Parent window. Should not be @NULL.
-        
-        @param id 
-        Control identifier. A value of -1 denotes a default value.
-        
-        @param label 
-        Bitmap label.
-        
-        @param pos 
-        Window position.
-        
-        @param size 
-        Window size.
-        
-        @param style 
-        Window style. See wxStaticBitmap.
-        
-        @param name 
-        Window name.
-        
-        @sa Create()
+      Default constructor
     */
     wxStaticBitmap();
-        wxStaticBitmap(wxWindow* parent, wxWindowID id,
-                       const wxBitmap& label,
-                       const wxPoint& pos = wxDefaultPosition,
-                       const wxSize& size = wxDefaultSize,
-                       long style = 0,
-                       const wxString& name = "staticBitmap");
-    //@}
+    
+    /**
+        Constructor, creating and showing a static bitmap control.
+
+        @param parent
+            Parent window. Should not be @NULL.
+        @param id
+            Control identifier. A value of -1 denotes a default value.
+        @param label
+            Bitmap label.
+        @param pos
+            Window position.
+        @param size
+            Window size.
+        @param style
+            Window style. See wxStaticBitmap.
+        @param name
+            Window name.
+
+        @see Create()
+    */
+    wxStaticBitmap(wxWindow* parent, wxWindowID id,
+                   const wxBitmap& label,
+                   const wxPoint& pos = wxDefaultPosition,
+                   const wxSize& size = wxDefaultSize,
+                   long style = 0,
+                   const wxString& name = "staticBitmap");
 
     /**
         Creation function, for two-step construction. For details see wxStaticBitmap().
@@ -75,36 +70,37 @@ public:
     /**
         Returns the bitmap currently used in the control. Notice that this method can
         be called even if SetIcon() had been used.
-        
-        @sa SetBitmap()
+
+        @see SetBitmap()
     */
-    wxBitmap GetBitmap();
+    wxBitmap GetBitmap() const;
 
     /**
         Returns the icon currently used in the control. Notice that this method can
         only be called if SetIcon() had been used: an icon
-        can't be retrieved from the control if a bitmap had been set (using 
+        can't be retrieved from the control if a bitmap had been set (using
         wxStaticBitmap::SetBitmap).
-        
-        @sa SetIcon()
+
+        @see SetIcon()
     */
-    wxIcon GetIcon();
+    wxIcon GetIcon() const;
 
     /**
         Sets the bitmap label.
-        
-        @param label 
-        The new bitmap.
-        
-        @sa GetBitmap()
+
+        @param label
+            The new bitmap.
+
+        @see GetBitmap()
     */
     virtual void SetBitmap(const wxBitmap& label);
 
     /**
         Sets the label to the given icon.
-        
-        @param label 
-        The new icon.
+
+        @param label
+            The new icon.
     */
     virtual void SetIcon(const wxIcon& label);
 };
+