documented Set/GetIcon(), added (not quite pure) virtual GetIcon() in the base class

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

diff --git a/docs/latex/wx/statbmp.tex b/docs/latex/wx/statbmp.tex
index 7c24e752143e1cb1e0ba4b42d0ab34f0ef2e271f..2b88fd850628ba5df24227fb7f9de74abf04b204 100644 (file)
--- a/docs/latex/wx/statbmp.tex
+++ b/docs/latex/wx/statbmp.tex
@@ -79,15 +79,30 @@ Creation function, for two-step construction. For details see \helpref{wxStaticB
 
 \membersection{wxStaticBitmap::GetBitmap}\label{wxstaticbitmapgetbitmap}
 
-\constfunc{wxBitmap\&}{GetBitmap}{\void}
+\constfunc{wxBitmap}{GetBitmap}{\void}
 
-Returns a reference to the label bitmap.
+Returns the bitmap currently used in the control. Notice that this method can
+be called even if \helpref{SetIcon}{wxstaticbitmapseticon} had been used.
 
 \wxheading{See also}
 
 \helpref{wxStaticBitmap::SetBitmap}{wxstaticbitmapsetbitmap}
 
 
+\membersection{wxStaticIcon::GetIcon}\label{wxstaticbitmapgeticon}
+
+\constfunc{wxIcon}{GetIcon}{\void}
+
+Returns the icon currently used in the control. Notice that this method can
+only be called if \helpref{SetIcon}{wxstaticbitmapseticon} had been used: an icon
+can't be retrieved from the control if a bitmap had been set (using 
+\helpref{SetBitmap}{wxstaticbitmapsetbitmap}).
+
+\wxheading{See also}
+
+\helpref{wxStaticIcon::SetIcon}{wxstaticbitmapseticon}
+
+
 \membersection{wxStaticBitmap::SetBitmap}\label{wxstaticbitmapsetbitmap}
 
 \func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{ label}}
@@ -102,3 +117,18 @@ Sets the bitmap label.
 
 \helpref{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap}
 
+
+\membersection{wxStaticIcon::SetIcon}\label{wxstaticbitmapseticon}
+
+\func{virtual void}{SetIcon}{\param{const wxIcon\& }{ label}}
+
+Sets the label to the given icon.
+
+\wxheading{Parameters}
+
+\docparam{label}{The new icon.}
+
+\wxheading{See also}
+
+\helpref{wxStaticIcon::GetIcon}{wxstaticbitmapgeticon}
+

diff --git a/include/wx/msw/statbmp.h b/include/wx/msw/statbmp.h
index 82b1a921a17a35d68f91618adb1c02cb7a1b4573..d580d8a7313162cc3e746593fee32016cb461339 100644 (file)
--- a/include/wx/msw/statbmp.h
+++ b/include/wx/msw/statbmp.h
@@ -49,12 +49,8 @@ public:
 
     virtual void SetIcon(const wxIcon& icon) { SetImage(&icon); }
     virtual void SetBitmap(const wxBitmap& bitmap) { SetImage(&bitmap); }
-
-    // can always be used, whether we have a bitmap or an icon in reality
-    wxBitmap GetBitmap() const;
-
-    // can only be used if an icon had been originally used
-    wxIcon GetIcon() const;
+    virtual wxBitmap GetBitmap() const;
+    virtual wxIcon GetIcon() const;
 
 
 protected:

diff --git a/include/wx/statbmp.h b/include/wx/statbmp.h
index d215bc3bda67f84775711e190df113b216fae694..80b4d2dcf819289760fd15993b5707bc483fa05c 100644 (file)
--- a/include/wx/statbmp.h
+++ b/include/wx/statbmp.h
@@ -18,9 +18,7 @@
 
 #include "wx/control.h"
 #include "wx/bitmap.h"
-
-class WXDLLEXPORT wxIcon;
-class WXDLLEXPORT wxBitmap;
+#include "wx/icon.h"
 
 extern WXDLLEXPORT_DATA(const wxChar*) wxStaticBitmapNameStr;
 
@@ -35,6 +33,12 @@ public:
     virtual void SetIcon(const wxIcon& icon) = 0;
     virtual void SetBitmap(const wxBitmap& bitmap) = 0;
     virtual wxBitmap GetBitmap() const = 0;
+    virtual wxIcon GetIcon() const /* = 0 -- should be pure virtual */
+    {
+        // stub it out here for now as not all ports implement it (but they
+        // should)
+        return wxIcon();
+    }
 
     // overriden base class virtuals
     virtual bool AcceptsFocus() const { return false; }