]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/statbmp.h
Added mostly empty wxLaunchDefaultApplication
[wxWidgets.git] / interface / statbmp.h
index 9c32646962954a68856777facbb414bcd66f4819..d18ff1fe396bda9bb09f34c82d2f76fde1acf884 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
     @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.
+    A static bitmap control displays a bitmap. Native implementations on some 
+    platforms are only meant for display of the small icons in the dialog 
+    boxes. In particular, under Windows 9x the size of bitmap is limited
+    to 64*64 pixels.
+    If you want to display larger images portably, you may use generic 
+    implementation wxGenericStaticBitmap declared in <wx/generic/statbmpg.h>.
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{staticbitmap.png}
+    <!-- @appearance{staticbitmap.png} -->
 
-    @seealso
-    wxStaticBitmap, wxStaticBox
+    @see wxStaticBitmap, wxStaticBox
 */
 class wxStaticBitmap : public wxControl
 {
 public:
-    //@{
+    /**
+      Default constructor
+    */
+    wxStaticBitmap();
+    
     /**
         Constructor, creating and showing a static bitmap control.
-        
+
         @param parent
             Parent window. Should not be @NULL.
         @param id
@@ -44,17 +48,15 @@ public:
             Window style. See wxStaticBitmap.
         @param name
             Window name.
-        
+
         @see Create()
     */
-    wxStaticBitmap();
     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().
@@ -69,36 +71,37 @@ public:
     /**
         Returns the bitmap currently used in the control. Notice that this method can
         be called even if SetIcon() had been used.
-        
+
         @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
         wxStaticBitmap::SetBitmap).
-        
+
         @see SetIcon()
     */
-    wxIcon GetIcon();
+    wxIcon GetIcon() const;
 
     /**
         Sets the bitmap label.
-        
+
         @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.
     */
     virtual void SetIcon(const wxIcon& label);
 };
+