%extend {
wxVisualAttributes() { return new wxVisualAttributes; }
~wxVisualAttributes() { delete self; }
- }
+ }
// the font used for control label/text inside it
wxFont font;
");
+MustHaveApp(wxWindow);
+MustHaveApp(wxWindow::FindFocus);
+MustHaveApp(wxWindow::GetCapture);
+
+// This one is not restricted to wxWindow
+MustHaveApp(GetClassDefaultAttributes);
class wxWindow : public wxEvtHandler
{
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,
"Moves the window to the given position.", "",
MoveXY);
+ DocDeclStr(
+ void , SetBestFittingSize(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.", "");
+
-
+
DocDeclStr(
virtual void , Raise(),
"Raises the window to the top of the window hierarchy if it is a
DocDeclStr(
wxRect , GetClientRect() const,
- "Get the client area position and size as a wx.Rect object.", "");
+ "Get the client area position and size as a `wx.Rect` object.", "");
DocStr(GetBestSize,
- "This functions returns the best acceptable minimal size for the
+ "This function returns the best acceptable minimal size for the
window, if applicable. For example, for a static text control, it will
be the minimal size such that the control label is not truncated. For
windows containing subwindows (suzh aswx.Panel), the size returned by
GetBestSizeTuple);
+ DocDeclStr(
+ void , InvalidateBestSize(),
+ "Reset the cached best size value so it will be recalculated the next
+time it is needed.", "");
+
+
+
+ DocDeclStr(
+ wxSize , GetBestFittingSize() 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.
+", "");
+
+
DocDeclStr(
wxSize , GetAdjustedBestSize() const,
"This method is similar to GetBestSize, except in one
- %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
default values will be used. If this function is called, the user
-will not be able to size the window outside the given bounds. The
-resizing increments are only significant under Motif or Xt.", "");
+will not be able to size the window outside the given bounds (if it is
+a top-level window.) Sizers will also inspect the minimum window size
+and will use that value if set when calculating layout.
+
+The resizing increments are only significant under Motif or Xt.", "
+
+:see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
+");
virtual void SetSizeHints( int minW, int minH,
int maxW = -1, int maxH = -1,
int incW = -1, int incH = -1 );
- void SetSizeHints( const wxSize& minSize,
- const wxSize& maxSize=wxDefaultSize,
- const wxSize& incSize=wxDefaultSize);
+ %name(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
the virtual area of the window outside the given bounds.", "");
virtual void SetVirtualSizeHints( int minW, int minH,
int maxW = -1, int maxH = -1 );
- void SetVirtualSizeHints( const wxSize& minSize,
- const wxSize& maxSize=wxDefaultSize);
+ %name(SetVirtualSizeHintsSz)void SetVirtualSizeHints(
+ const wxSize& minSize, const wxSize& maxSize=wxDefaultSize);
+
+
DocDeclStr(
- virtual int , GetMinWidth() const,
+ virtual wxSize , GetMaxSize() const,
"", "");
DocDeclStr(
- virtual int , GetMinHeight() const,
+ virtual wxSize , GetMinSize() const,
"", "");
DocDeclStr(
- int , GetMaxWidth() const,
+ void , SetMinSize(const wxSize& minSize),
+ "A more convenient method than `SetSizeHints` for setting just the
+min size.", "");
+
+ DocDeclStr(
+ void , SetMaxSize(const wxSize& maxSize),
+ "A more convenient method than `SetSizeHints` for setting just the
+max size.", "");
+
+
+
+ DocDeclStr(
+ virtual int , GetMinWidth() const,
"", "");
DocDeclStr(
- int , GetMaxHeight() const,
+ virtual int , GetMinHeight() const,
"", "");
-
DocDeclStr(
- virtual wxSize , GetMaxSize() const,
+ int , GetMaxWidth() const,
"", "");
-
DocDeclStr(
- virtual wxSize , GetMinSize() const,
+ int , GetMaxHeight() const,
"", "");
+
DocStr(SetVirtualSize,
"Set the the virtual size of a window in pixels. For most windows this
is just the client area of the window, but for some like scrolled
"Set this child as temporary default", "");
+ DocDeclAStr(
+ virtual bool , Navigate(int flags = wxNavigationKeyEvent::IsForward),
+ "Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool",
+ "Does keyboard navigation from this window to another, by sending a
+`wx.NavigationKeyEvent`.", "
+
+ :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.", "");
+
+
+
+
+
// parent/children relations
// -------------------------
useful if you want to use the same font or colour in your own control
as in a standard control -- which is a much better idea than hard
coding specific colours or fonts which might look completely out of
-place on the users system, especially if it uses themes.", "");
+place on the user's system, especially if it uses themes.", "");
DocDeclStr(
"Get the default attributes for this class. This is useful if you want
to use the same font or colour in your own control as in a standard
control -- which is a much better idea than hard coding specific
-colours or fonts which might look completely out of place on the users
-system, especially if it uses themes.
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
ignore under other platforms. Under Mac, it will change the size of
-the returned font. See SetWindowVariant for more about this.", "");
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.", "");
DocDeclStr(
"Sets the background colour of the window. Returns True if the colour
was changed. The background colour is usually painted by the default
EVT_ERASE_BACKGROUND event handler function under Windows and
-automatically under GTK.
+automatically under GTK. Using `wx.NullColour` will reset the window
+to the default background colour.
-Note that setting the background colour does not cause an immediate
-refresh, so you may wish to call ClearBackground or Refresh after
+Note that setting the background colour may not cause an immediate
+refresh, so you may wish to call `ClearBackground` or `Refresh` after
calling this function.
-Use this function with care under GTK+ as the new appearance of the
-window might not look equally well when used with themes, i.e GTK+'s
-ability to change its look as the user wishes with run-time loadable
-modules.", "");
+Using this function will disable attempts to use themes for this
+window, if the system supports them. Use with care since usually the
+themes represent the appearance chosen by the user to be used for all
+applications on the system.", "");
DocDeclStr(
- void , SetDefaultBackgroundColour(const wxColour& colour),
+ void , SetOwnBackgroundColour(const wxColour& colour),
"", "");
not be used at all.", "");
DocDeclStr(
- void , SetDefaultForegroundColour(const wxColour& colour),
+ void , SetOwnForegroundColour(const wxColour& colour),
"", "");
be reset back to default.", "");
DocDeclStr(
- wxCursor& , GetCursor(),
+ wxCursor , GetCursor(),
"Return the cursor associated with this window.", "");
"Sets the font for this window.", "");
DocDeclStr(
- void , SetDefaultFont(const wxFont& font),
+ void , SetOwnFont(const wxFont& font),
"", "");
DocDeclStr(
- wxFont& , GetFont(),
+ wxFont , GetFont(),
"Returns the default font used for this window.", "");
DocStr(PopupMenu,
- "Pops up the given menu at the specified coordinates, relative to this
-window, and returns control when the user has dismissed the menu. If a
-menu item is selected, the corresponding menu event is generated and
-will be processed as usual.", "");
- %name(PopupMenuXY) bool PopupMenu(wxMenu *menu, int x, int y);
- bool PopupMenu(wxMenu *menu, const wxPoint& pos);
+ "Pops up the given menu at the specified coordinates, relative to this window,
+and returns control when the user has dismissed the menu. If a menu item is
+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);
+ bool PopupMenu(wxMenu *menu, const wxPoint& pos=wxDefaultPosition);
By 'intelligently' the following is meant: by default, all windows use
their own default attributes. However if some of the parent's
attributes are explicitly changed (that is, using SetFont and not
-SetDefaultFont) and if the corresponding attribute hadn't been
+SetOwnFont) and if the corresponding attribute hadn't been
explicitly set for this window itself, then this window takes the same
value as used by the parent. In addition, if the window overrides
ShouldInheritColours to return false, the colours will not be changed
hierarchy. The search is recursive in both cases.", "");
+MustHaveApp(wxFindWindowById);
+MustHaveApp(wxFindWindowByName);
+MustHaveApp(wxFindWindowByLabel);
+
%inline %{
wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) {
return wxWindow::FindWindowById(id, parent);
projects / wxWidgets.git / blobdiff