%extend {
wxVisualAttributes() { return new wxVisualAttributes; }
~wxVisualAttributes() { delete self; }
- }
+ }
// the font used for control label/text inside it
wxFont font;
wx.WS_EX_PROCESS_IDLE This window should always process idle
events, even if the mode set by
- wx.IdleEvent.SetMode is
+ `wx.IdleEvent.SetMode` is
wx.IDLE_PROCESS_SPECIFIED.
wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI
update events, even if the mode
- set by wxUpdateUIEvent::SetMode is
+ set by `wx.UpdateUIEvent.SetMode` is
wxUPDATE_UI_PROCESS_SPECIFIED.
============================= =====================================
public:
%pythonAppend wxWindow "self._setOORInfo(self)"
%pythonAppend wxWindow() ""
+ %typemap(out) wxWindow*; // turn off this typemap
DocCtorStr(
wxWindow(wxWindow* parent, const wxWindowID id=-1,
"Precreate a Window for 2-phase creation.", "",
PreWindow);
+ // Turn it back on again
+ %typemap(out) wxWindow* { $result = wxPyMake_wxObject($1, $owner); }
+
DocDeclStr(
bool , Create(wxWindow* parent, const wxWindowID id=-1,
const wxPoint& pos = wxDefaultPosition,
DocDeclStr(
- bool , Close( bool force = False ),
+ bool , Close( bool force = false ),
"This function simply generates a EVT_CLOSE event whose handler usually
tries to close the window. It doesn't close the window itself,
however. If force is False (the default) then the window's close
+ %pythonPrepend Destroy "args[0].this.own(False)"
DocDeclStr(
virtual bool , Destroy(),
"Destroys the window safely. Frames and dialogs are not destroyed
// window attributes
// -----------------
- DocDeclStr(
- virtual void , SetTitle( const wxString& title),
- "Sets the window's title. Applicable only to frames and dialogs.", "");
-
- DocDeclStr(
- virtual wxString , GetTitle() const,
- "Gets the window's title. Applicable only to frames and dialogs.", "");
+ //DocDeclStr(
+ // virtual void , SetTitle( const wxString& title),
+ // "Sets the window's title. Applicable only to frames and dialogs.", "");
+ //DocDeclStr(
+ // virtual wxString , GetTitle() const,
+ // "Gets the window's title. Applicable only to frames and dialogs.", "");
DocDeclStr(
virtual void , SetLabel(const wxString& label),
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
int sizeFlags = wxSIZE_AUTO ),
"Sets the position and size of the window in pixels. The sizeFlags
parameter indicates the interpretation of the other params if they are
--1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
-shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
-used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
-dimensions of -1 and less to be interpreted as real dimensions, not
-default values.", "",
+equal to -1.
+
+ ======================== ======================================
+ wx.SIZE_AUTO A -1 indicates that a class-specific
+ default should be used.
+ wx.SIZE_USE_EXISTING Axisting dimensions should be used if
+ -1 values are supplied.
+ wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
+ interpreted as real dimensions, not
+ default values.
+ ======================== ======================================
+", "",
SetDimensions);
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.", "");
-
+ %pythoncode { SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`') }
DocDeclStr(
virtual void , Raise(),
- "Raises the window to the top of the window hierarchy if it is a
-managed window (dialog or frame).", "");
+ "Raises the window to the top of the window hierarchy. In current
+version of wxWidgets this works both for manage and child windows.", "");
DocDeclStr(
virtual void , Lower(),
- "Lowers the window to the bottom of the window hierarchy if it is a
-managed window (dialog or frame).", "");
+ "Lowers the window to the bottom of the window hierarchy. In current
+version of wxWidgets this works both for manage and child windows.", "");
dimensions the border or title bar have when trying to fit the window
around panel items, for example.", "");
void SetClientSize( const wxSize& size );
- %name(SetClientSizeWH) void SetClientSize( int width, int height );
- %name(SetClientRect) void SetClientSize(const wxRect& rect);
+ %Rename(SetClientSizeWH, void, SetClientSize( int width, int height ));
+ %Rename(SetClientRect, void, SetClientSize(const wxRect& rect));
DocStr(GetPosition, // sets the docstring for both
- "Get the window's position.", "");
- wxPoint GetPosition();
+ "Get the window's position. Notice that the position is in client
+coordinates for child windows and screen coordinates for the top level
+ones, use `GetScreenPosition` if you need screen coordinates for all
+kinds of windows.", "");
+ wxPoint GetPosition() const;
DocDeclAName(
- void, GetPosition(int *OUTPUT, int *OUTPUT),
+ void, GetPosition(int *OUTPUT, int *OUTPUT) const,
"GetPositionTuple() -> (x,y)",
GetPositionTuple);
+
+ DocStr(GetScreenPosition, // sets the docstring for both
+ "Get the position of the window in screen coordinantes.", "");
+ wxPoint GetScreenPosition() const;
+ DocDeclAName(
+ void, GetScreenPosition(int *OUTPUT, int *OUTPUT) const,
+ "GetScreenPositionTuple() -> (x,y)",
+ GetScreenPositionTuple);
+
+ DocDeclStr(
+ wxRect , GetScreenRect() const,
+ "Returns the size and position of the window in screen coordinantes as
+a `wx.Rect` object.", "
+:see: `GetRect`, `GetScreenPosition`");
+
DocStr(GetSize, "Get the window size.", "");
wxSize GetSize() const;
DocDeclStr(
wxRect , GetRect() const,
- "Returns the size and position of the window as a wx.Rect object.", "");
+ "Returns the size and position of the window as a `wx.Rect` object.", "");
DocStr(GetClientSize,
"Reset the cached best size value so it will be recalculated the next
time it is needed.", "");
+ DocDeclStr(
+ void , CacheBestSize(const wxSize& size) const,
+ "Cache the best size so it doesn't need to be calculated again, (at least until
+some properties of the window change.)", "");
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.
", "");
-
+ %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
also include wx.CENTER_ON_SCREEN flag if you want to center the window
on the entire screen and not on its parent window. If it is a
top-level window and has no parent then it will always be centered
-relative to the screen.", "");
-
+relative to the screen.", "");
%pythoncode { Centre = Center }
- DocDeclStr(
- void , CenterOnScreen(int dir = wxBOTH),
- "Center on screen (only works for top level windows)", "");
- %pythoncode { CentreOnScreen = CenterOnScreen }
-
-
DocDeclStr(
void , CenterOnParent(int dir = wxBOTH),
"Center with respect to the the parent window", "");
- %nokwargs SetSizeHints;
DocStr(SetSizeHints,
"Allows specification of minimum and maximum window sizes, and window
size increments. If a pair of values is not set (or set to -1), the
:see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
");
- void SetSizeHints( const wxSize& minSize,
- const wxSize& maxSize=wxDefaultSize,
- const wxSize& incSize=wxDefaultSize);
virtual void SetSizeHints( int minW, int minH,
int maxW = -1, int maxH = -1,
int incW = -1, int incH = -1 );
+ %Rename(SetSizeHintsSz, void, SetSizeHints( const wxSize& minSize,
+ const wxSize& maxSize=wxDefaultSize,
+ const wxSize& incSize=wxDefaultSize));
- %nokwargs SetVirtualSizeHints;
DocStr(SetVirtualSizeHints,
"Allows specification of minimum and maximum virtual window sizes. If a
pair of values is not set (or set to -1), the default values will be
used. If this function is called, the user will not be able to size
the virtual area of the window outside the given bounds.", "");
- void SetVirtualSizeHints( const wxSize& minSize,
- const wxSize& maxSize=wxDefaultSize);
virtual void SetVirtualSizeHints( int minW, int minH,
int maxW = -1, int maxH = -1 );
+ %Rename(SetVirtualSizeHintsSz, void, SetVirtualSizeHints(
+ const wxSize& minSize, const wxSize& maxSize=wxDefaultSize));
+
+
DocDeclStr(
virtual wxSize , GetMaxSize() const,
"", "");
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(
- void , SetMaxSize(const wxSize& maxSize),
+ virtual void , SetMaxSize(const wxSize& maxSize),
"A more convenient method than `SetSizeHints` for setting just the
max size.", "");
is just the client area of the window, but for some like scrolled
windows it is more or less independent of the screen window size.", "");
void SetVirtualSize(const wxSize& size );
- %name(SetVirtualSizeWH) void SetVirtualSize( int w, int h );
+ %Rename(SetVirtualSizeWH, void, SetVirtualSize( int w, int h ));
DocStr(GetVirtualSize,
+// void SetScrollHelper( wxScrollHelper *sh );
+// wxScrollHelper *GetScrollHelper();
+
+
// window state
// ------------
DocDeclStr(
- virtual bool , Show( bool show = True ),
+ virtual bool , Show( bool show = true ),
"Shows or hides the window. You may need to call Raise for a top level
window if you want to bring it to top, although this is not needed if
Show is called immediately after the frame creation. Returns True if
DocDeclStr(
- virtual bool , Enable( bool enable = True ),
+ virtual bool , Enable( bool enable = true ),
"Enable or disable the window for user input. Note that when a parent
window is disabled, all of its children are disabled as well and they
are reenabled again when the parent is. Returns true if the window
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.", "");
+
DocDeclStr(
- virtual void , MakeModal(bool modal = True),
+ virtual void , MakeModal(bool modal = true),
"Disables all other windows in the application so that the user can
only interact with this window. Passing False will reverse this
effect.", "");
-
- DocDeclStr(
- virtual wxWindow *, GetDefaultItem() const,
- "Get the default child of this parent, i.e. the one which is activated
-by pressing <Enter> such as the OK button on a wx.Dialog.", "");
-
- DocDeclStr(
- virtual wxWindow *, SetDefaultItem(wxWindow * child),
- "Set this child as default, return the old default.", "");
-
- DocDeclStr(
- virtual void , SetTmpDefaultItem(wxWindow * win),
- "Set this child as temporary default", "");
-
DocDeclAStr(
virtual bool , Navigate(int flags = wxNavigationKeyEvent::IsForward),
"Does keyboard navigation from this window to another, by sending a
`wx.NavigationKeyEvent`.", "
- :param flags: A combination of the ``IsForward`` and ``WinChange``
- values in the `wx.NavigationKeyEvent` class, which determine
- if the navigation should be in forward or reverse order, and
- if it should be able to cross parent window boundaries, such
- as between notebook pages or MDI child frames. Typically the
- status of the Shift key (for forward or reverse) or the
- Control key (for WinChange) would be used to determine how to
- set the flags.
+ :param flags: A combination of the ``IsForward`` or ``IsBackward``
+ and the ``WinChange`` values in the `wx.NavigationKeyEvent`
+ class, which determine if the navigation should be in forward
+ or reverse order, and if it should be able to cross parent
+ window boundaries, such as between notebook pages or MDI child
+ frames. Typically the status of the Shift key (for forward or
+ backward) or the Control key (for WinChange) would be used to
+ determine how to set the flags.
One situation in which you may wish to call this method is from a text
control custom keypress handler to do the default navigation behaviour
for the tab key, since the standard default behaviour for a multiline
text control with the wx.TE_PROCESS_TAB style is to insert a tab and
not navigate to the next control.");
+
+ DocDeclStr(
+ void , MoveAfterInTabOrder(wxWindow *win),
+ "Moves this window in the tab navigation order after the specified
+sibling window. This means that when the user presses the TAB key on
+that other window, the focus switches to this window.
+
+The default tab order is the same as creation order. This function
+and `MoveBeforeInTabOrder` allow to change it after creating all the
+windows.
+", "");
+
+
+ DocDeclStr(
+ void , MoveBeforeInTabOrder(wxWindow *win),
+ "Same as `MoveAfterInTabOrder` except that it inserts this window just
+before win instead of putting it right after it.", "");
+
+
+
+
+
"Removes a child window. This is called automatically by window
deletion functions so should not be required by the application
programmer.", "");
-
+ DocStr(SetDoubleBuffered,
+ "Currently wxGTK2 only.", "");
+#ifdef __WXGTK__
+ void SetDoubleBuffered(bool on);
+#else
+ %extend {
+ void SetDoubleBuffered(bool on) {}
+ }
+#endif
+
// looking for windows
// -------------------
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
-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
-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
-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 ),
+ 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
-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.)", "");
%#if wxUSE_HOTKEY
return self->RegisterHotKey(hotkeyId, modifiers, keycode);
%#else
- return False;
+ return false;
%#endif
}
#if wxUSE_HOTKEY
return self->UnregisterHotKey(hotkeyId);
#else
- return False;
+ return false;
#endif
}
}
average character width and then divided by 4. For the y dimension,
the dialog units are multiplied by the average character height and
then divided by 8.", "");
- %name(ConvertDialogPointToPixels) wxPoint ConvertDialogToPixels(const wxPoint& pt);
- %name(ConvertDialogSizeToPixels) wxSize ConvertDialogToPixels(const wxSize& sz);
- %name(DLG_PNT) wxPoint ConvertDialogToPixels(const wxPoint& pt);
- %name(DLG_SZE) wxSize ConvertDialogToPixels(const wxSize& sz);
+ %Rename(ConvertDialogPointToPixels, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
+ %Rename(ConvertDialogSizeToPixels, wxSize, ConvertDialogToPixels(const wxSize& sz));
+ %Rename(DLG_PNT, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
+ %Rename(DLG_SZE, wxSize, ConvertDialogToPixels(const wxSize& sz));
DocStr(ConvertPixelPointToDialog,
average character width and then divided by 4. For the y dimension,
the dialog units are multiplied by the average character height and
then divided by 8.", "");
- %name(ConvertPixelPointToDialog) wxPoint ConvertPixelsToDialog(const wxPoint& pt);
- %name(ConvertPixelSizeToDialog) wxSize ConvertPixelsToDialog(const wxSize& sz);
+ %Rename(ConvertPixelPointToDialog, wxPoint, ConvertPixelsToDialog(const wxPoint& pt));
+ %Rename(ConvertPixelSizeToDialog, wxSize, ConvertPixelsToDialog(const wxSize& sz));
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(
- virtual void , Refresh( bool eraseBackground = True,
+ virtual void , Refresh( bool eraseBackground = true,
const wxRect *rect = NULL ),
"Mark the specified rectangle (or the whole window) as \"dirty\" so it
will be repainted. Causes an EVT_PAINT event to be generated and sent
DocDeclStr(
- void , RefreshRect(const wxRect& rect),
+ void , RefreshRect(const wxRect& rect, bool eraseBackground = true),
"Redraws the contents of the given rectangle: the area inside it will
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
-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.", "");
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
"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(
optimize redrawing by only redrawing those areas, which have been
exposed.", "");
bool IsExposed( int x, int y, int w=1, int h=1 ) const;
- %name(IsExposedPoint) bool IsExposed( const wxPoint& pt ) const;
- %name(IsExposedRect) bool IsExposed( const wxRect& rect ) const;
+ %Rename(IsExposedPoint, bool, IsExposed( const wxPoint& pt ) const);
+ %Rename(IsExposedRect, bool, IsExposed( const wxRect& rect ) const);
applications on the system.", "");
DocDeclStr(
- void , SetOwnBackroundColour(const wxColour& colour),
+ void , SetOwnBackgroundColour(const wxColour& colour),
"", "");
"Returns the foreground colour of the window. The interpretation of
foreground colour is dependent on the window class; it may be the text
colour or other colour, or it may not be used at all.", "");
+
+ DocDeclStr(
+ bool , InheritsBackgroundColour() const,
+ "", "");
+
+ DocDeclStr(
+ bool , UseBgCol() const,
+ "", "");
+
+// TODO:
+// // if the window shouldn't inherit its colour from the parent, override
+// // this function to return true
+// //
+// // this is currently only used by wxMSW and wxUniv but should be useful for
+// // the other ports too
+// virtual bool ProvidesBackground() const;
+
+
+ // Set/get the background style.
+ // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
+ DocDeclStr(
+ virtual bool , SetBackgroundStyle(wxBackgroundStyle style),
+ "Returns the background style of the window. The background style
+indicates how the background of the window is drawn.
+
+ ====================== ========================================
+ wx.BG_STYLE_SYSTEM The background colour or pattern should
+ be determined by the system
+ wx.BG_STYLE_COLOUR The background should be a solid colour
+ wx.BG_STYLE_CUSTOM The background will be implemented by the
+ application.
+ ====================== ========================================
+
+On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
+a custom background, such as a tiled bitmap. Currently the style has
+no effect on other platforms.
+
+:see: `GetBackgroundStyle`, `SetBackgroundColour`", "");
+
+ DocDeclStr(
+ virtual wxBackgroundStyle , GetBackgroundStyle() const,
+ "Returns the background style of the window.
+:see: `SetBackgroundStyle`", "");
+ DocDeclStr(
+ bool , HasTransparentBackground(),
+ "Returns True if this window's background is transparent (as, for
+example, for `wx.StaticText`) and should show the parent window's
+background.
+
+This method is mostly used internally by the library itself and you
+normally shouldn't have to call it. You may, however, have to override
+it in your custom control classes to ensure that background is painted
+correctly.", "");
+
+
DocDeclStr(
virtual bool , SetCursor( const wxCursor &cursor ),
"Sets the window's cursor. Notice that the window cursor also sets it
+ %disownarg( wxCaret *caret );
DocDeclStr(
void , SetCaret(wxCaret *caret),
"Sets the caret associated with the window.", "");
+ %cleardisown( wxCaret *caret );
DocDeclStr(
wxCaret *, GetCaret() const,
function from your application to ensure that your UI is up-to-date at
a particular point in time (as far as your EVT_UPDATE_UI handlers are
concerned). This may be necessary if you have called
-wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
+`wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
limit the overhead that wxWindows incurs by sending update UI events
in idle time.",
"
selected, the corresponding menu event is generated and will be processed as
usual. If the default position is given then the current position of the
mouse cursor will be used.", "");
- %name(PopupMenuXY) bool PopupMenu(wxMenu *menu, int x=-1, int y=-1);
+ %Rename(PopupMenuXY, bool, PopupMenu(wxMenu *menu, int x=-1, int y=-1));
bool PopupMenu(wxMenu *menu, const wxPoint& pos=wxDefaultPosition);
-
+ DocDeclStr(
+ virtual bool , HasMultiplePages() const,
+ "", "");
+
%extend {
DocStr(GetHandle,
}
}
+ DocStr(
+ AssociateHandle,
+ "Associate the window with a new native handle", "");
+ %extend {
+ void AssociateHandle(long handle) {
+ self->AssociateHandle((WXWidget)handle);
+ }
+ }
+
+
+ DocDeclStr(
+ virtual void , DissociateHandle(),
+ "Dissociate the current native handle from the window", "");
+
#ifdef __WXMSW__
int position,
int thumbSize,
int range,
- bool refresh = True ),
+ bool refresh = true ),
"Sets the scrollbar properties of a built-in scrollbar.",
"
:param orientation: Determines the scrollbar whose page size is to
");
DocDeclStr(
- virtual void , SetScrollPos( int orientation, int pos, bool refresh = True ),
+ virtual void , SetScrollPos( int orientation, int pos, bool refresh = true ),
"Sets the position of one of the built-in scrollbars.", "");
DocDeclStr(
"Physically scrolls the pixels in the window and move child windows
accordingly. Use this function to optimise your scrolling
implementations, to minimise the area that must be redrawn. Note that
-it is rarely required to call this function from a user program.",
-"
+it is rarely required to call this function from a user program.","
+
:param dx: Amount to scroll horizontally.
:param dy: Amount to scroll vertically.
void , SetHelpText(const wxString& text),
"Sets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
-wxHelpProvider implementation, and not in the window object itself.", "");
+`wx.HelpProvider` implementation, and not in the window object itself.", "");
DocDeclStr(
DocDeclStr(
+ virtual wxString , GetHelpTextAtPoint(const wxPoint& pt,
+ wxHelpEvent::Origin origin) const,
+ "Get the help string associated with the given position in this window.
+
+Notice that pt may be invalid if event origin is keyboard or unknown
+and this method should return the global window help text then
+", "");
+
+
+ DocDeclStr(
wxString , GetHelpText() const,
"Gets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
-wxHelpProvider implementation, and not in the window object itself.", "");
+`wx.HelpProvider` implementation, and not in the window object itself.", "");
DocStr(SetToolTip,
"Attach a tooltip to the window.", "");
- %name(SetToolTipString) void SetToolTip( const wxString &tip );
+ %Rename(SetToolTipString, void, SetToolTip( const wxString &tip ));
+
+ %disownarg( wxToolTip *tip );
void SetToolTip( wxToolTip *tip );
+ %cleardisown( wxToolTip *tip );
DocDeclStr(
wxToolTip* , GetToolTip() const,
// drag and drop
// -------------
- // set/retrieve the drop target associated with this window (may be
- // NULL; it's owned by the window and will be deleted by it)
- %apply SWIGTYPE *DISOWN { wxPyDropTarget *dropTarget };
-
+ %disownarg( wxPyDropTarget *dropTarget );
DocDeclStr(
virtual void , SetDropTarget( wxPyDropTarget *dropTarget ),
"Associates a drop target with this window. If the window already has
a drop target, it is deleted.", "");
-
- %clear wxPyDropTarget *dropTarget;
+ %cleardisown( wxPyDropTarget *dropTarget );
DocDeclStr(
"Returns the associated drop target, which may be None.", "");
-#ifdef __WXMSW__ // TODO: should I drop-kick this?
- DocDeclStr(
- void , DragAcceptFiles(bool accept),
+ DocStr(DragAcceptFiles,
"Enables or disables eligibility for drop file events, EVT_DROP_FILES.
-Only available on Windows.", "");
+Only functional on Windows.", "");
+#ifdef __WXMSW__
+ void DragAcceptFiles(bool accept);
+#else
+ %extend {
+ void DragAcceptFiles(bool accept) {}
+ }
#endif
#endif
// constraints and sizers
// ----------------------
- // set the constraints for this window or retrieve them (may be NULL)
+ %disownarg(wxLayoutConstraints*);
DocDeclStr(
void , SetConstraints( wxLayoutConstraints *constraints ),
"Sets the window to have the given layout constraints. If an existing
wxLayoutConstraints *, GetConstraints() const,
"Returns a pointer to the window's layout constraints, or None if there
are none.", "");
+ %cleardisown(wxLayoutConstraints*);
DocDeclStr(
void , SetAutoLayout( bool autoLayout ),
"Determines whether the Layout function will be called automatically
-when the window is resized. It is called implicitly by SetSizer but
-if you use SetConstraints you should call it manually or otherwise the
-window layout won't be correctly updated when its size changes.", "");
+when the window is resized. lease note that this only happens for the
+windows usually used to contain children, namely `wx.Panel` and
+`wx.TopLevelWindow` (and the classes deriving from them).
+
+This method is called implicitly by `SetSizer` but if you use
+`SetConstraints` you should call it manually or otherwise the window
+layout won't be correctly updated when its size changes.", "");
DocDeclStr(
bool , GetAutoLayout() const,
handler when the window is resized.", "");
+ %disownarg( wxSizer *sizer );
DocDeclStr(
- void , SetSizer(wxSizer *sizer, bool deleteOld = True ),
+ void , SetSizer(wxSizer *sizer, bool deleteOld = true ),
"Sets the window to have the given layout sizer. The window will then
own the object, and will take care of its deletion. If an existing
layout sizer object is already owned by the window, it will be deleted
if the deleteOld parameter is true. Note that this function will also
call SetAutoLayout implicitly with a True parameter if the sizer is
-non-NoneL and False otherwise.", "");
+non-None, and False otherwise.", "");
DocDeclStr(
- void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = True ),
+ void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ),
"The same as SetSizer, except it also sets the size hints for the
window based on the sizer's minimum size.", "");
-
+ %cleardisown( wxSizer *sizer );
+
DocDeclStr(
wxSizer *, GetSizer() const,
ShouldInheritColours to return false, the colours will not be changed
no matter what and only the font might.
-This rather complicated logic is necessary in order to accomodate the
-different usage scenarius. The most common one is when all default
+This rather complicated logic is necessary in order to accommodate the
+different usage scenarios. The most common one is when all default
attributes are used and in this case, nothing should be inherited as
in modern GUIs different controls use different fonts (and colours)
than their siblings so they can't inherit the same value from the
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 {
if hasattr(self, '_setOORInfo'):
self._setOORInfo(self)
if hasattr(self, '_setCallbackInfo'):
- self._setCallbackInfo(self, self.__class__)
+ self._setCallbackInfo(self, pre.__class__)
}
-};
+ %pythoncode {
+ 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`");
+
+};
WXHWND hWnd = (WXHWND)_hWnd;
long id = wxGetWindowId(hWnd);
wxWindow* win = new wxWindow;
- parent->AddChild(win);
+ if (parent)
+ parent->AddChild(win);
win->SetEventHandler(win);
win->SetHWND(hWnd);
win->SetId(id);
}
%}
+//---------------------------------------------------------------------------
+
+DocStr(GetTopLevelWindows,
+"Returns a list of the the application's top-level windows, (frames,
+dialogs, etc.) NOTE: Currently this is a copy of the list maintained
+by wxWidgets, and so it is only valid as long as no top-level windows
+are closed or new top-level windows are created.
+", "");
+%inline %{
+ PyObject* GetTopLevelWindows() {
+ return wxPy_ConvertList(&wxTopLevelWindows);
+ }
+%}
+
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
projects / wxWidgets.git / blobdiff