A patch from Frame Niessink which adds an additional style that

[wxWidgets.git] / wxPython / src / _window.i

diff --git a/wxPython/src/_window.i b/wxPython/src/_window.i
index 2e014bcd137229de7392d1a2259888e631892cb3..f4c883a59e56357b5dfeb0dfa883f4601abd3f49 100644 (file)
--- a/wxPython/src/_window.i
+++ b/wxPython/src/_window.i
@@ -259,7 +259,7 @@ instead.");
     
 
 
     
 
 

-    %pythonAppend Destroy "args[0].thisown = 0"
+    %pythonPrepend Destroy "args[0].this.own(False)"

     DocDeclStr(
         virtual bool , Destroy(),
         "Destroys the window safely.  Frames and dialogs are not destroyed
     DocDeclStr(
         virtual bool , Destroy(),
         "Destroys the window safely.  Frames and dialogs are not destroyed


@@ -373,6 +373,25 @@ autogenerated) id", "");
 autogenerated) id", "");
     
 
 autogenerated) id", "");
     
 

+    DocDeclStr(
+        virtual wxLayoutDirection , GetLayoutDirection() const,
+        "Get the layout direction (LTR or RTL) for this window.  Returns
+``wx.Layout_Default`` if layout direction is not supported.", "");
+    
+    DocDeclStr(
+        virtual void , SetLayoutDirection(wxLayoutDirection dir),
+        "Set the layout direction (LTR or RTL) for this window.", "");
+    
+
+    DocDeclStr(
+        virtual wxCoord , AdjustForLayoutDirection(wxCoord x,
+                                             wxCoord width,
+                                                   wxCoord widthTotal) const,
+        "Mirror coordinates for RTL layout if this window uses it and if the
+mirroring is not done automatically like Win32.", "");
+    
+
+    

 
 
     // moving/resizing
 
 
     // moving/resizing


@@ -429,10 +448,10 @@ equal to -1.
         MoveXY);
     
     DocDeclStr(
         MoveXY);
     
     DocDeclStr(

-        void , SetBestFittingSize(const wxSize& size=wxDefaultSize),
+        void , SetInitialSize(const wxSize& size=wxDefaultSize),

         "A 'Smart' SetSize that will fill in default size components with the
 window's *best size* values.  Also set's the minsize for use with sizers.", "");
         "A 'Smart' SetSize that will fill in default size components with the
 window's *best size* values.  Also set's the minsize for use with sizers.", "");

-    
+    %pythoncode { SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`') }

 
     
     DocDeclStr(
 
     
     DocDeclStr(


@@ -552,25 +571,23 @@ some properties of the window change.)", "");
 
     
     DocDeclStr(
 
     
     DocDeclStr(

-        wxSize , GetBestFittingSize() const,
+        wxSize , GetEffectiveMinSize() const,

         "This function will merge the window's best size into the window's
 minimum size, giving priority to the min size components, and returns
 the results.
 ", "");
         "This function will merge the window's best size into the window's
 minimum size, giving priority to the min size components, and returns
 the results.
 ", "");

-    
+    %pythoncode { GetBestFittingSize = wx._deprecated(GetEffectiveMinSize, 'Use `GetEffectiveMinSize` instead.') }

 
 

-    DocDeclStr(
-        wxSize , GetAdjustedBestSize() const,
-        "This method is similar to GetBestSize, except in one
-thing. GetBestSize should return the minimum untruncated size of the
-window, while this method will return the largest of BestSize and any
-user specified minimum size. ie. it is the minimum size the window
-should currently be drawn at, not the minimal size it can possibly
-tolerate.", "");
+    %pythoncode {
+        def GetAdjustedBestSize(self):
+            s = self.GetBestSize()
+            return wx.Size(max(s.width,  self.GetMinWidth()),
+                           max(s.height, self.GetMinHeight()))
+        GetAdjustedBestSize = wx._deprecated(GetAdjustedBestSize, 'Use `GetEffectiveMinSize` instead.')
+    }

     
 
 
     
 
 

-

     DocDeclStr(
         void , Center( int direction = wxBOTH ),
         "Centers the window.  The parameter specifies the direction for
     DocDeclStr(
         void , Center( int direction = wxBOTH ),
         "Centers the window.  The parameter specifies the direction for


@@ -651,12 +668,12 @@ the virtual area of the window outside the given bounds.", "");
         "", "");
     
     DocDeclStr(
         "", "");
     
     DocDeclStr(

-        void , SetMinSize(const wxSize& minSize),
+        virtual void , SetMinSize(const wxSize& minSize),

         "A more convenient method than `SetSizeHints` for setting just the
 min size.", "");
     
     DocDeclStr(
         "A more convenient method than `SetSizeHints` for setting just the
 min size.", "");
     
     DocDeclStr(

-        void , SetMaxSize(const wxSize& maxSize),
+        virtual void , SetMaxSize(const wxSize& maxSize),

         "A more convenient method than `SetSizeHints` for setting just the
 max size.", "");
     
         "A more convenient method than `SetSizeHints` for setting just the
 max size.", "");
     


@@ -714,6 +731,10 @@ sizer, interior children, or other means)", "");
     
 
 
     
 
 

+//     void SetScrollHelper( wxScrollHelper *sh );
+//     wxScrollHelper *GetScrollHelper();
+    
+

     // window state
     // ------------
 
     // window state
     // ------------
 


@@ -751,6 +772,12 @@ window had already been in the specified state.", "");
         bool , IsEnabled() const,
         "Returns true if the window is enabled for input, false otherwise.", "");
 
         bool , IsEnabled() const,
         "Returns true if the window is enabled for input, false otherwise.", "");
 

+    DocDeclStr(
+        virtual bool , IsShownOnScreen() const,
+        "Returns ``True`` if the window is physically visible on the screen,
+i.e. it is shown and all its parents up to the toplevel window are
+shown as well.", "");
+    

     
 
 
     
 
 


@@ -1006,42 +1033,48 @@ its own event handler.", "");
     DocDeclStr(
         void , SetEventHandler( wxEvtHandler *handler ),
         "Sets the event handler for this window.  An event handler is an object
     DocDeclStr(
         void , SetEventHandler( wxEvtHandler *handler ),
         "Sets the event handler for this window.  An event handler is an object

-that is capable of processing the events sent to a window. By default,
-the window is its own event handler, but an application may wish to
-substitute another, for example to allow central implementation of
-event-handling for a variety of different window classes.
+that is capable of processing the events sent to a window.  (In other
+words, is able to dispatch the events to handler function.)  By
+default, the window is its own event handler, but an application may
+wish to substitute another, for example to allow central
+implementation of event-handling for a variety of different window
+classes.

 
 It is usually better to use `wx.Window.PushEventHandler` since this sets
 up a chain of event handlers, where an event not handled by one event
 
 It is usually better to use `wx.Window.PushEventHandler` since this sets
 up a chain of event handlers, where an event not handled by one event

-handler is handed to the next one in the chain.", "");
+handler is handed off to the next one in the chain.", "");

     
 
     DocDeclStr(
         void , PushEventHandler( wxEvtHandler *handler ),
         "Pushes this event handler onto the event handler stack for the window.
 An event handler is an object that is capable of processing the events
     
 
     DocDeclStr(
         void , PushEventHandler( wxEvtHandler *handler ),
         "Pushes this event handler onto the event handler stack for the window.
 An event handler is an object that is capable of processing the events

-sent to a window. By default, the window is its own event handler, but
-an application may wish to substitute another, for example to allow
-central implementation of event-handling for a variety of different
-window classes.
+sent to a window.  (In other words, is able to dispatch the events to
+handler function.)  By default, the window is its own event handler,
+but an application may wish to substitute another, for example to
+allow central implementation of event-handling for a variety of
+different window classes.

 
 wx.Window.PushEventHandler allows an application to set up a chain of
 event handlers, where an event not handled by one event handler is
 
 wx.Window.PushEventHandler allows an application to set up a chain of
 event handlers, where an event not handled by one event handler is

-handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
-remove the event handler.", "");
+handed to the next one in the chain.  Use `wx.Window.PopEventHandler`
+to remove the event handler.  Ownership of the handler is *not* given
+to the window, so you should be sure to pop the handler before the
+window is destroyed and either let PopEventHandler destroy it, or call
+its Destroy method yourself.", "");

 
     
     DocDeclStr(
         wxEvtHandler *, PopEventHandler( bool deleteHandler = false ),
         "Removes and returns the top-most event handler on the event handler
 stack.  If deleteHandler is True then the wx.EvtHandler object will be
 
     
     DocDeclStr(
         wxEvtHandler *, PopEventHandler( bool deleteHandler = false ),
         "Removes and returns the top-most event handler on the event handler
 stack.  If deleteHandler is True then the wx.EvtHandler object will be

-destroyed after it is popped.", "");
+destroyed after it is popped, and ``None`` will be returned instead.", "");

     
 
     DocDeclStr(
         bool , RemoveEventHandler(wxEvtHandler *handler),
         "Find the given handler in the event handler chain and remove (but not
     
 
     DocDeclStr(
         bool , RemoveEventHandler(wxEvtHandler *handler),
         "Find the given handler in the event handler chain and remove (but not

-delete) it from the event handler chain, return True if it was found
+delete) it from the event handler chain, returns True if it was found

 and False otherwise (this also results in an assert failure so this
 function should only be called when the handler is supposed to be
 there.)", "");
 and False otherwise (this also results in an assert failure so this
 function should only be called when the handler is supposed to be
 there.)", "");


@@ -1193,7 +1226,13 @@ Note that wxWindows maintains the stack of windows having captured the
 mouse and when the mouse is released the capture returns to the window
 which had had captured it previously and it is only really released if
 there were no previous window. In particular, this means that you must
 mouse and when the mouse is released the capture returns to the window
 which had had captured it previously and it is only really released if
 there were no previous window. In particular, this means that you must

-release the mouse as many times as you capture it.", "");
+release the mouse as many times as you capture it, unless the window
+receives the `wx.MouseCaptureLostEvent` event.
+ 
+Any application which captures the mouse in the beginning of some
+operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
+operation when it receives the event. The event handler must not
+recapture mouse.", "");

     
     DocDeclStr(
         void , ReleaseMouse(),
     
     DocDeclStr(
         void , ReleaseMouse(),


@@ -1236,7 +1275,7 @@ be repainted.  This is the same as Refresh but has a nicer syntax.", "");
 window instead of waiting for the EVT_PAINT event to happen, (normally
 this would usually only happen when the flow of control returns to the
 event loop.)  Notice that this function doesn't refresh the window and
 window instead of waiting for the EVT_PAINT event to happen, (normally
 this would usually only happen when the flow of control returns to the
 event loop.)  Notice that this function doesn't refresh the window and

-does nothing if the window has been already repainted.  Use Refresh
+does nothing if the window has been already repainted.  Use `Refresh`

 first if you want to immediately redraw the window (or some portion of
 it) unconditionally.", "");
     
 first if you want to immediately redraw the window (or some portion of
 it) unconditionally.", "");
     


@@ -1261,8 +1300,16 @@ it is a good idea to use it before inserting large amount of text into
 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
 for all controls so it is mostly just a hint to wxWindows and not a
 mandatory directive.", "");
 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
 for all controls so it is mostly just a hint to wxWindows and not a
 mandatory directive.", "");

+

     
     

+    DocDeclStr(
+        virtual bool , IsFrozen() const,
+        "Returns ``True`` if the window has been frozen and not thawed yet.

 
 

+:see: `Freeze` and `Thaw`", "");
+    
+
+    

     DocDeclStr(
         virtual void , Thaw(),
         "Reenables window updating after a previous call to Freeze.  Calls to
     DocDeclStr(
         virtual void , Thaw(),
         "Reenables window updating after a previous call to Freeze.  Calls to


@@ -1275,6 +1322,13 @@ times that Freeze was before the window will be updated.", "");
         "Call this function to prepare the device context for drawing a
 scrolled image. It sets the device origin according to the current
 scroll position.", "");
         "Call this function to prepare the device context for drawing a
 scrolled image. It sets the device origin according to the current
 scroll position.", "");

+
+    DocDeclStr(
+        virtual bool , IsDoubleBuffered() const,
+        "Returns ``True`` if the window contents is double-buffered by the
+system, i.e. if any drawing done on the window is really done on a
+temporary backing surface and transferred to the screen all at once
+later.", "");

     
 
     DocDeclStr(
     
 
     DocDeclStr(


@@ -1975,6 +2029,26 @@ from the parent window.
 The base class version returns false, but this method is overridden in
 wxControl where it returns true.", "");
     
 The base class version returns false, but this method is overridden in
 wxControl where it returns true.", "");
     

+
+
+    DocDeclStr(
+        virtual bool , CanSetTransparent(),
+        "Returns ``True`` if the platform supports setting the transparency for
+this window.  Note that this method will err on the side of caution,
+so it is possible that this will return ``False`` when it is in fact
+possible to set the transparency.
+
+NOTE: On X-windows systems the X server must have the composite
+extension loaded, and there must be a composite manager program (such
+as xcompmgr) running.", "");
+
+    DocDeclStr(
+        virtual bool , SetTransparent(byte alpha),
+        "Attempt to set the transparency of this window to the ``alpha`` value,
+returns True on success.  The ``alpha`` value is an integer in the
+range of 0 to 255, where 0 is fully transparent and 255 is fully
+opaque.", "");
+    

     
 
     %pythoncode {
     
 
     %pythoncode {


@@ -1996,9 +2070,68 @@ wxControl where it returns true.", "");
     def SendSizeEvent(self):
         self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
     }
     def SendSizeEvent(self):
         self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
     }

-};
-

 
 

+    
+    %property(AcceleratorTable, GetAcceleratorTable, SetAcceleratorTable, doc="See `GetAcceleratorTable` and `SetAcceleratorTable`");
+    %property(AdjustedBestSize, GetAdjustedBestSize, doc="See `GetAdjustedBestSize`");
+    %property(AutoLayout, GetAutoLayout, SetAutoLayout, doc="See `GetAutoLayout` and `SetAutoLayout`");
+    %property(BackgroundColour, GetBackgroundColour, SetBackgroundColour, doc="See `GetBackgroundColour` and `SetBackgroundColour`");
+    %property(BackgroundStyle, GetBackgroundStyle, SetBackgroundStyle, doc="See `GetBackgroundStyle` and `SetBackgroundStyle`");
+    %property(EffectiveMinSize, GetEffectiveMinSize, doc="See `GetEffectiveMinSize`");
+    %property(BestSize, GetBestSize, doc="See `GetBestSize`");
+    %property(BestVirtualSize, GetBestVirtualSize, doc="See `GetBestVirtualSize`");
+    %property(Border, GetBorder, doc="See `GetBorder`");
+    %property(Caret, GetCaret, SetCaret, doc="See `GetCaret` and `SetCaret`");
+    %property(CharHeight, GetCharHeight, doc="See `GetCharHeight`");
+    %property(CharWidth, GetCharWidth, doc="See `GetCharWidth`");
+    %property(Children, GetChildren, doc="See `GetChildren`");
+    %property(ClientAreaOrigin, GetClientAreaOrigin, doc="See `GetClientAreaOrigin`");
+    %property(ClientRect, GetClientRect, SetClientRect, doc="See `GetClientRect` and `SetClientRect`");
+    %property(ClientSize, GetClientSize, SetClientSize, doc="See `GetClientSize` and `SetClientSize`");
+    %property(Constraints, GetConstraints, SetConstraints, doc="See `GetConstraints` and `SetConstraints`");
+    %property(ContainingSizer, GetContainingSizer, SetContainingSizer, doc="See `GetContainingSizer` and `SetContainingSizer`");
+    %property(Cursor, GetCursor, SetCursor, doc="See `GetCursor` and `SetCursor`");
+    %property(DefaultAttributes, GetDefaultAttributes, doc="See `GetDefaultAttributes`");
+    %property(DropTarget, GetDropTarget, SetDropTarget, doc="See `GetDropTarget` and `SetDropTarget`");
+    %property(EventHandler, GetEventHandler, SetEventHandler, doc="See `GetEventHandler` and `SetEventHandler`");
+    %property(ExtraStyle, GetExtraStyle, SetExtraStyle, doc="See `GetExtraStyle` and `SetExtraStyle`");
+    %property(Font, GetFont, SetFont, doc="See `GetFont` and `SetFont`");
+    %property(ForegroundColour, GetForegroundColour, SetForegroundColour, doc="See `GetForegroundColour` and `SetForegroundColour`");
+    %property(GrandParent, GetGrandParent, doc="See `GetGrandParent`");
+    %property(Handle, GetHandle, doc="See `GetHandle`");
+    %property(HelpText, GetHelpText, SetHelpText, doc="See `GetHelpText` and `SetHelpText`");
+    %property(Id, GetId, SetId, doc="See `GetId` and `SetId`");
+    %property(Label, GetLabel, SetLabel, doc="See `GetLabel` and `SetLabel`");
+    %property(LayoutDirection, GetLayoutDirection, SetLayoutDirection, doc="See `GetLayoutDirection` and `SetLayoutDirection`");
+    %property(MaxHeight, GetMaxHeight, doc="See `GetMaxHeight`");
+    %property(MaxSize, GetMaxSize, SetMaxSize, doc="See `GetMaxSize` and `SetMaxSize`");
+    %property(MaxWidth, GetMaxWidth, doc="See `GetMaxWidth`");
+    %property(MinHeight, GetMinHeight, doc="See `GetMinHeight`");
+    %property(MinSize, GetMinSize, SetMinSize, doc="See `GetMinSize` and `SetMinSize`");
+    %property(MinWidth, GetMinWidth, doc="See `GetMinWidth`");
+    %property(Name, GetName, SetName, doc="See `GetName` and `SetName`");
+    %property(Parent, GetParent, doc="See `GetParent`");
+    %property(Position, GetPosition, SetPosition, doc="See `GetPosition` and `SetPosition`");
+    %property(Rect, GetRect, SetRect, doc="See `GetRect` and `SetRect`");
+    %property(ScreenPosition, GetScreenPosition, doc="See `GetScreenPosition`");
+    %property(ScreenRect, GetScreenRect, doc="See `GetScreenRect`");
+    %property(Size, GetSize, SetSize, doc="See `GetSize` and `SetSize`");
+    %property(Sizer, GetSizer, SetSizer, doc="See `GetSizer` and `SetSizer`");
+    %property(ThemeEnabled, GetThemeEnabled, SetThemeEnabled, doc="See `GetThemeEnabled` and `SetThemeEnabled`");
+    %property(ToolTip, GetToolTip, SetToolTip, doc="See `GetToolTip` and `SetToolTip`");
+    %property(UpdateClientRect, GetUpdateClientRect, doc="See `GetUpdateClientRect`");
+    %property(UpdateRegion, GetUpdateRegion, doc="See `GetUpdateRegion`");
+    %property(Validator, GetValidator, SetValidator, doc="See `GetValidator` and `SetValidator`");
+    %property(VirtualSize, GetVirtualSize, SetVirtualSize, doc="See `GetVirtualSize` and `SetVirtualSize`");
+    %property(WindowStyle, GetWindowStyle, SetWindowStyle, doc="See `GetWindowStyle` and `SetWindowStyle`");
+    %property(WindowStyleFlag, GetWindowStyleFlag, SetWindowStyleFlag, doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`");
+    %property(WindowVariant, GetWindowVariant, SetWindowVariant, doc="See `GetWindowVariant` and `SetWindowVariant`");
+
+    %property(Shown, IsShown, Show, doc="See `IsShown` and `Show`");
+    %property(Enabled, IsEnabled, Enable, doc="See `IsEnabled` and `Enable`");
+    %property(TopLevel, IsTopLevel, doc="See `IsTopLevel`");
+    
+};