Added GetPureVitualSize() returning just m_virtualSize.

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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index 3edf6e0a2408f1bdc218cab828a5cf288cc229a9..236aa313eb61010c8d048375a6cf27cb6d74cf1d 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -1112,6 +1112,18 @@ method:\par
 }}
 
 
 }}
 
 

+\membersection{wxWindow::GetPureVirtualSize}\label{wxwindowgetpurevirtualsize}
+
+\constfunc{wxSize}{GetPureVirtualSize}{\void}
+
+This gets the virtual size of the window in pixels as it has been set
+by \helpref{SetVirtualSize}{wxwindowsetvirtualsize}.
+
+\helpref{GetSize}{wxwindowgetsize},\rtfsp
+\helpref{GetClientSize}{wxwindowgetclientsize},\rtfsp
+\helpref{GetVirtualSize}{wxwindowgetvirtualsize}
+
+

 \membersection{wxWindow::GetRect}\label{wxwindowgetrect}
 
 \constfunc{virtual wxRect}{GetRect}{\void}
 \membersection{wxWindow::GetRect}\label{wxwindowgetrect}
 
 \constfunc{virtual wxRect}{GetRect}{\void}


@@ -1281,7 +1293,11 @@ Returns a pointer to the current validator for the window, or NULL if there is n
 
 \constfunc{wxSize}{GetVirtualSize}{\void}
 
 
 \constfunc{wxSize}{GetVirtualSize}{\void}
 

-This gets the virtual size of the window in pixels.
+This gets the virtual size of the window in pixels as it has been set
+by \helpref{SetVirtualSize}{wxwindowsetvirtualsize} or the size of the
+client area, if it is larger. Use 
+\helpref{GetPureVirtualSize}{wxwindowgetpurevirtualsize} if you want
+to get the actual virtual height independent of the client size.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

diff --git a/include/wx/window.h b/include/wx/window.h
index 8874dded7ed3e3bade22b55fb2aa53fc1cfbab75..ed8bfdd743f8f0ddedbc93d4f570ad665a26e330 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -424,10 +424,16 @@ public:
 
         // Override these methods for windows that have a virtual size
         // independent of their client size.  eg. the virtual area of a
 
         // Override these methods for windows that have a virtual size
         // independent of their client size.  eg. the virtual area of a

-        // wxScrolledWindow.  Default is to alias VirtualSize to ClientSize.
+        // wxScrolledWindow.  Default is to return m_virtualSize unless
+        // the client size is bigger.

 
     virtual void DoSetVirtualSize( int x, int y );
 
     virtual void DoSetVirtualSize( int x, int y );

-    virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
+    virtual wxSize DoGetVirtualSize() const;
+    
+    
+        // Really return just m_virtualSize, nothing else
+    
+    wxSize GetPureVirtualSize() const { return m_virtualSize; }

 
         // Return the largest of ClientSize and BestSize (as determined
         // by a sizer, interior children, or other means)
 
         // Return the largest of ClientSize and BestSize (as determined
         // by a sizer, interior children, or other means)