addind nonowned window implementation

[wxWidgets.git] / interface / splitter.h

diff --git a/interface/splitter.h b/interface/splitter.h
index 9c86b3675dc97631a5ee84841b8e026b0af3bbe2..60648935f8b7b445b7c6b267650bd49e573a6fd7 100644 (file)
--- a/interface/splitter.h
+++ b/interface/splitter.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        splitter.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        splitter.h

-// Purpose:     documentation for wxSplitterWindow class
+// Purpose:     interface of wxSplitterWindow

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -41,8 +41,7 @@
     @library{wxcore}
     @category{miscwnd}
 
     @library{wxcore}
     @category{miscwnd}
 

-    @seealso
-    wxSplitterEvent
+    @see wxSplitterEvent

 */
 class wxSplitterWindow : public wxWindow
 {
 */
 class wxSplitterWindow : public wxWindow
 {


@@ -50,7 +49,7 @@ public:
     //@{
     /**
         Constructor for creating the window.
     //@{
     /**
         Constructor for creating the window.

-        
+

         @param parent
             The parent of the splitter window.
         @param id
         @param parent
             The parent of the splitter window.
         @param id


@@ -63,14 +62,14 @@ public:
             The window style. See wxSplitterWindow.
         @param name
             The window name.
             The window style. See wxSplitterWindow.
         @param name
             The window name.

-        
+

         @remarks After using this constructor, you must create either one or two
                  subwindows with the splitter window as parent, and then
                  call one of Initialize(),
                  SplitVertically() and
                  SplitHorizontally() in order to set the
                  pane(s).
         @remarks After using this constructor, you must create either one or two
                  subwindows with the splitter window as parent, and then
                  call one of Initialize(),
                  SplitVertically() and
                  SplitHorizontally() in order to set the
                  pane(s).

-        
+

         @see Initialize(), SplitVertically(),
              SplitHorizontally(), Create()
     */
         @see Initialize(), SplitVertically(),
              SplitHorizontally(), Create()
     */


@@ -99,28 +98,28 @@ public:
 
     /**
         Returns the current minimum pane size (defaults to zero).
 
     /**
         Returns the current minimum pane size (defaults to zero).

-        
+

         @see SetMinimumPaneSize()
     */
     int GetMinimumPaneSize() const;
 
     /**
         Returns the current sash gravity.
         @see SetMinimumPaneSize()
     */
     int GetMinimumPaneSize() const;
 
     /**
         Returns the current sash gravity.

-        
+

         @see SetSashGravity()
     */
     double GetSashGravity();
 
     /**
         Returns the current sash position.
         @see SetSashGravity()
     */
     double GetSashGravity();
 
     /**
         Returns the current sash position.

-        
+

         @see SetSashPosition()
     */
     int GetSashPosition();
 
     /**
         Gets the split mode.
         @see SetSashPosition()
     */
     int GetSashPosition();
 
     /**
         Gets the split mode.

-        
+

         @see SetSplitMode(), SplitVertically(),
              SplitHorizontally().
     */
         @see SetSplitMode(), SplitVertically(),
              SplitHorizontally().
     */


@@ -139,13 +138,13 @@ public:
     /**
         Initializes the splitter window to have one pane.  The child window is
         shown if it is currently hidden.
     /**
         Initializes the splitter window to have one pane.  The child window is
         shown if it is currently hidden.

-        
+

         @param window
             The pane for the unsplit window.
         @param window
             The pane for the unsplit window.

-        
+

         @remarks This should be called if you wish to initially view only a
                  single pane in the splitter window.
         @remarks This should be called if you wish to initially view only a
                  single pane in the splitter window.

-        
+

         @see SplitVertically(), SplitHorizontally()
     */
     void Initialize(wxWindow* window);
         @see SplitVertically(), SplitHorizontally()
     */
     void Initialize(wxWindow* window);


@@ -158,15 +157,15 @@ public:
     /**
         Application-overridable function called when the sash is double-clicked with
         the left mouse button.
     /**
         Application-overridable function called when the sash is double-clicked with
         the left mouse button.

-        
+

         @param x
             The x position of the mouse cursor.
         @param y
             The y position of the mouse cursor.
         @param x
             The x position of the mouse cursor.
         @param y
             The y position of the mouse cursor.

-        
+

         @remarks The default implementation of this function calls Unsplit if the
                  minimum pane size is zero.
         @remarks The default implementation of this function calls Unsplit if the
                  minimum pane size is zero.

-        
+

         @see Unsplit()
     */
     virtual void OnDoubleClickSash(int x, int y);
         @see Unsplit()
     */
     virtual void OnDoubleClickSash(int x, int y);


@@ -174,10 +173,10 @@ public:
     /**
         Application-overridable function called when the sash position is changed by
         user. It may return @false to prevent the change or @true to allow it.
     /**
         Application-overridable function called when the sash position is changed by
         user. It may return @false to prevent the change or @true to allow it.

-        
+

         @param newSashPosition
             The new sash position (always positive or zero)
         @param newSashPosition
             The new sash position (always positive or zero)

-        
+

         @remarks The default implementation of this function verifies that the
                  sizes of both  panes of the splitter are greater than
                  minimum pane size.
         @remarks The default implementation of this function verifies that the
                  sizes of both  panes of the splitter are greater than
                  minimum pane size.


@@ -187,10 +186,10 @@ public:
     /**
         Application-overridable function called when the window is unsplit, either
         programmatically or using the wxSplitterWindow user interface.
     /**
         Application-overridable function called when the window is unsplit, either
         programmatically or using the wxSplitterWindow user interface.

-        
+

         @param removed
             The window being removed.
         @param removed
             The window being removed.

-        
+

         @remarks The default implementation of this function simply hides
                  removed. You may wish to delete the window.
     */
         @remarks The default implementation of this function simply hides
                  removed. You may wish to delete the window.
     */


@@ -207,17 +206,17 @@ public:
         couldn't be replaced, @false is returned. Otherwise the function will return
         @true, but please notice that it will not delete the replaced window and you
         may wish to do it yourself.
         couldn't be replaced, @false is returned. Otherwise the function will return
         @true, but please notice that it will not delete the replaced window and you
         may wish to do it yourself.

-        
+

         @see GetMinimumPaneSize()
     */
     bool ReplaceWindow(wxWindow* winOld, wxWindow* winNew);
 
     /**
         Sets the minimum pane size.
         @see GetMinimumPaneSize()
     */
     bool ReplaceWindow(wxWindow* winOld, wxWindow* winNew);
 
     /**
         Sets the minimum pane size.

-        
+

         @param paneSize
             Minimum pane size in pixels.
         @param paneSize
             Minimum pane size in pixels.

-        
+

         @remarks The default minimum pane size is zero, which means that either
                  pane can be reduced to zero by dragging the sash, thus
                  removing one of the panes. To prevent this behaviour
         @remarks The default minimum pane size is zero, which means that either
                  pane can be reduced to zero by dragging the sash, thus
                  removing one of the panes. To prevent this behaviour


@@ -225,31 +224,31 @@ public:
                  size, for example 20 pixels. If the wxSP_PERMIT_UNSPLIT
                  style is used when a splitter window is created, the
                  window may be unsplit even if minimum size is non-zero.
                  size, for example 20 pixels. If the wxSP_PERMIT_UNSPLIT
                  style is used when a splitter window is created, the
                  window may be unsplit even if minimum size is non-zero.

-        
+

         @see GetMinimumPaneSize()
     */
     void SetMinimumPaneSize(int paneSize);
 
     /**
         Sets the sash gravity.
         @see GetMinimumPaneSize()
     */
     void SetMinimumPaneSize(int paneSize);
 
     /**
         Sets the sash gravity.

-        
+

         @param gravity
             The sash gravity. Value between 0.0 and 1.0.
         @param gravity
             The sash gravity. Value between 0.0 and 1.0.

-        
+

         @see GetSashGravity()
     */
     void SetSashGravity(double gravity);
 
     /**
         Sets the sash position.
         @see GetSashGravity()
     */
     void SetSashGravity(double gravity);
 
     /**
         Sets the sash position.

-        
+

         @param position
             The sash position in pixels.
         @param redraw
             If @true, resizes the panes and redraws the sash and border.
         @param position
             The sash position in pixels.
         @param redraw
             If @true, resizes the panes and redraws the sash and border.

-        
+

         @remarks Does not currently check for an out-of-range value.
         @remarks Does not currently check for an out-of-range value.

-        
+

         @see GetSashPosition()
     */
     void SetSashPosition(int position, const bool redraw = true);
         @see GetSashPosition()
     */
     void SetSashPosition(int position, const bool redraw = true);


@@ -265,12 +264,12 @@ public:
 
     /**
         Sets the split mode.
 
     /**
         Sets the split mode.

-        
+

         @param mode
             Can be wxSPLIT_VERTICAL or wxSPLIT_HORIZONTAL.
         @param mode
             Can be wxSPLIT_VERTICAL or wxSPLIT_HORIZONTAL.

-        
+

         @remarks Only sets the internal variable; does not update the display.
         @remarks Only sets the internal variable; does not update the display.

-        
+

         @see GetSplitMode(), SplitVertically(),
              SplitHorizontally().
     */
         @see GetSplitMode(), SplitVertically(),
              SplitHorizontally().
     */


@@ -279,7 +278,7 @@ public:
     /**
         Initializes the top and bottom panes of the splitter window.  The
         child windows are shown if they are currently hidden.
     /**
         Initializes the top and bottom panes of the splitter window.  The
         child windows are shown if they are currently hidden.

-        
+

         @param window1
             The top pane.
         @param window2
         @param window1
             The top pane.
         @param window2


@@ -290,15 +289,15 @@ public:
             absolute value gives the size of the lower pane. Finally, specify 0
         (default)
             to choose the default position (half of the total window height).
             absolute value gives the size of the lower pane. Finally, specify 0
         (default)
             to choose the default position (half of the total window height).

-        
+

         @returns @true if successful, @false otherwise (the window was already
                  split).
         @returns @true if successful, @false otherwise (the window was already
                  split).

-        
+

         @remarks This should be called if you wish to initially view two panes.
                  It can also be called at any subsequent time, but the
                  application should check that the window is not
                  currently split using IsSplit.
         @remarks This should be called if you wish to initially view two panes.
                  It can also be called at any subsequent time, but the
                  application should check that the window is not
                  currently split using IsSplit.

-        
+

         @see SplitVertically(), IsSplit(),
              Unsplit()
     */
         @see SplitVertically(), IsSplit(),
              Unsplit()
     */


@@ -308,7 +307,7 @@ public:
     /**
         Initializes the left and right panes of the splitter window.  The
         child windows are shown if they are currently hidden.
     /**
         Initializes the left and right panes of the splitter window.  The
         child windows are shown if they are currently hidden.

-        
+

         @param window1
             The left pane.
         @param window2
         @param window1
             The left pane.
         @param window2


@@ -319,15 +318,15 @@ public:
             absolute value gives the size of the right pane. Finally, specify 0
         (default)
             to choose the default position (half of the total window width).
             absolute value gives the size of the right pane. Finally, specify 0
         (default)
             to choose the default position (half of the total window width).

-        
+

         @returns @true if successful, @false otherwise (the window was already
                  split).
         @returns @true if successful, @false otherwise (the window was already
                  split).

-        
+

         @remarks This should be called if you wish to initially view two panes.
                  It can also be called at any subsequent time, but the
                  application should check that the window is not
                  currently split using IsSplit.
         @remarks This should be called if you wish to initially view two panes.
                  It can also be called at any subsequent time, but the
                  application should check that the window is not
                  currently split using IsSplit.

-        
+

         @see SplitHorizontally(), IsSplit(),
              Unsplit().
     */
         @see SplitHorizontally(), IsSplit(),
              Unsplit().
     */


@@ -336,16 +335,16 @@ public:
 
     /**
         Unsplits the window.
 
     /**
         Unsplits the window.

-        
+

         @param toRemove
             The pane to remove, or @NULL to remove the right or bottom pane.
         @param toRemove
             The pane to remove, or @NULL to remove the right or bottom pane.

-        
+

         @returns @true if successful, @false otherwise (the window was not split).
         @returns @true if successful, @false otherwise (the window was not split).

-        
+

         @remarks This call will not actually delete the pane being removed; it
                  calls OnUnsplit which can be overridden for the desired
                  behaviour. By default, the pane being removed is hidden.
         @remarks This call will not actually delete the pane being removed; it
                  calls OnUnsplit which can be overridden for the desired
                  behaviour. By default, the pane being removed is hidden.

-        
+

         @see SplitHorizontally(), SplitVertically(),
              IsSplit(), OnUnsplit()
     */
         @see SplitHorizontally(), SplitVertically(),
              IsSplit(), OnUnsplit()
     */


@@ -365,6 +364,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxSplitterEvent
     @wxheader{splitter.h}
 /**
     @class wxSplitterEvent
     @wxheader{splitter.h}


@@ -379,8 +379,7 @@ public:
     @library{wxcore}
     @category{events}
 
     @library{wxcore}
     @category{events}
 

-    @seealso
-    wxSplitterWindow, @ref overview_eventhandlingoverview
+    @see wxSplitterWindow, @ref overview_eventhandlingoverview

 */
 class wxSplitterEvent : public wxNotifyEvent
 {
 */
 class wxSplitterEvent : public wxNotifyEvent
 {


@@ -431,9 +430,10 @@ public:
         May only be called while processing
         wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING and
         wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.
         May only be called while processing
         wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING and
         wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.

-        
+

         @param pos
             New sash position.
     */
     void SetSashPosition(int pos);
 };
         @param pos
             New sash position.
     */
     void SetSashPosition(int pos);
 };

+