Bases: wx._controls.TextCtrl
Text control used to display outputs. No editing allowed. The background is grayed out. User can’t select text.
See GetAcceleratorTable and SetAcceleratorTable
Can this window have focus?
Can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it.
Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer.
Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.
See GetAlignment
Associate the window with a new native handle
See GetAutoLayout and SetAutoLayout
See GetBackgroundColour and SetBackgroundColour
See GetBackgroundStyle and SetBackgroundStyle
See GetBestSize
See GetBestVirtualSize
Bind an event to an event handler.
| Parameters: |
|
|---|
See GetBorder
Cache the best size so it doesn’t need to be calculated again, (at least until some properties of the window change.)
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.
Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture.
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 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.
See GetCaret and SetCaret
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may 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.
Center with respect to the the parent window
Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may 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.
CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
See GetCharHeight
See GetCharWidth
See GetChildren
See GetClassName
Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated.
See GetClientAreaOrigin
See GetClientRect and SetClientRect
See GetClientSize and SetClientSize
Converts to screen coordinates from coordinates relative to this window.
Converts to screen coordinates from coordinates relative to this window.
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 handler will be allowed to veto the destruction of the window.
Simulates the effect of the user issuing a command to the item.
| See : | wx.CommandEvent |
|---|
See GetConstraints and SetConstraints
See GetContainingSizer and SetContainingSizer
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
Create(self, Window parent, int id=-1, String value=EmptyString, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, String name=TextCtrlNameStr) -> bool
See GetCursor and SetCursor
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
See GetDefaultAttributes
See GetDefaultStyle and SetDefaultStyle
Destroys the window safely. Frames and dialogs are not destroyed immediately when this function is called – they are added to a list of windows to be deleted on idle time, when all the window’s events have been processed. This prevents problems with events being sent to non-existent windows.
Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
Destroys all children of a window. Called automatically by the destructor.
Disables the window, same as Enable(false).
Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, PyObject func=None) -> bool
Dissociate the current native handle from the window
Enables or disables eligibility for drop file events, EVT_DROP_FILES.
See GetDropTarget and SetDropTarget
See GetEffectiveMinSize
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 has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.
See IsEnabled and Enable
See GetEventHandler and SetEventHandler
See GetEvtHandlerEnabled and SetEvtHandlerEnabled
See GetExtraStyle and SetExtraStyle
Returns the window or control that currently has the keyboard focus, or None.
Find a child of this window by window ID
Find a child of this window by label
Find a child of this window by name
Sizes the window so that it fits around its subwindows. This function won’t do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit.
Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won’t do anything if there are no subwindows.
See GetFont and SetFont
See GetForegroundColour and SetForegroundColour
Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw being delayed until all the nesting has been undone.
This method is useful for visual appearance optimization (for example, 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.
Gets the accelerator table for this window.
Use GetEffectiveMinSize instead.
Get the control alignment (left/right/centre, top/bottom/centre)
Returns the current autoLayout setting
Returns the background colour of the window.
Returns the background style of the window.
| See : | SetBackgroundStyle |
|---|
Use GetEffectiveMinSize instead.
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 (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
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 (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
GetBorder(self) -> int
Get border for the flags of this window
Returns the window which currently captures the mouse or None
Returns the caret associated with the window.
Get the (average) character size for the current font.
Get the (average) character size for the current font.
Returns an object containing a list of the window’s children. The object provides a Python sequence-like interface over the internal list maintained by the window..
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 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 wx.Window.SetWindowVariant for more about this.
Returns the class name of the C++ class using wxRTTI.
Get the origin of the client area of the window relative to the window’s top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)
Get the client area position and size as a wx.Rect object.
This gets the size of the window’s ‘client area’ in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
This gets the size of the window’s ‘client area’ in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
Returns a pointer to the window’s layout constraints, or None if there are none.
Return the sizer that this window is a member of, if any, otherwise None.
Return the cursor associated with this window.
Get the default attributes for an instance of 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 user’s system, especially if it uses themes.
Returns the associated drop target, which may be None.
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.
Returns the event handler for this window. By default, the window is its own event handler.
Returns the extra style bits for the window.
Returns the default font used for this window.
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.
(width, height, descent, externalLeading)
Get the width, height, decent and leading of the text using the current or specified font.
Returns the parent of the parent of this window, or None if there isn’t one.
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
Returns the platform-specific handle (as a long integer) of the physical window. On wxMSW this is the win32 window handle, on wxGTK it is the XWindow ID, and on wxMac it is the ControlRef.
Gets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current wx.HelpProvider implementation, and not in the window object itself.
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
Returns the identifier of the window. Each window has an integer identifier. If the application has not provided one (or the default Id -1 is used) then an unique identifier with a negative value will be generated.
Generic way of getting a label from any window, for identification purposes. The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs such as testing tools or special-needs access programs)which need to identify windows by name.
Get just the text of the label, without mnemonic characters (‘&’)
Get the layout direction (LTR or RTL) for this window. Returns wx.Layout_Default if layout direction is not supported.
Returns the windows name. This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via wx.Window.SetName.
Returns the parent window of this window, or None if there isn’t one.
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.
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.
Returns the size and position of the window as a wx.Rect object.
Get the position of the window in screen coordinantes.
Get the position of the window in screen coordinantes.
Returns the size and position of the window in screen coordinantes as a wx.Rect object.
Returns the built-in scrollbar position.
Returns the built-in scrollbar range.
Returns the built-in scrollbar thumb size.
If the return values from and to are the same, there is no selection.
Get the window size.
Get the window size.
Return the sizer associated with the window by a previous call to SetSizer or None if there isn’t one.
Get the width and height of the text using the current font.
Return the themeEnabled flag.
get the associated tooltip or None if none
Returns the first frame or dialog in this window’s parental hierarchy.
Get the update rectangle region bounding box in client coords.
Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler.
Returns a pointer to the current validator for the window, or None if there is none.
Get the the virtual size of the window in pixels. For most windows this 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.
Get the the virtual size of the window in pixels. For most windows this 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.
Return the size of the left/right and top/bottom borders.
GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create method.
Gets the window style that was passed to the constructor or Create method.
See GetGrandParent
GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
See GetHandle
Returns true if this window has the current mouse capture.
Test if the given style is set for this window.
Does the window have the scrollbar for this orientation?
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.
See GetHelpText and SetHelpText
Equivalent to calling Show(False).
Find the row, col coresponding to the character at the point given in pixels. NB: pt is in device coords but is not adjusted for the client area origin nor scrolling.
Find the character position in the text coresponding to the point given in pixels. NB: pt is in device coords but is not adjusted for the client area origin nor scrolling.
Test where the given (in client coords) point lies
See GetId and SetId
This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.
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 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 no matter what and only the font might.
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 parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes.
Sends an EVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.
See GetInsertionPoint and SetInsertionPoint
Reset the cached best size value so it will be recalculated the next time it is needed.
Is the window in the process of being deleted?
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.
Returns true if the window is enabled for input, false otherwise.
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
Returns True if the window has been frozen and not thawed yet.
| See : | Freeze and Thaw |
|---|
Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms.
For wx.Objects that use C++ reference counting internally, this method can be used to determine if two objects are referencing the same data object.
Returns true if the window is shown, false if it has been hidden.
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.
Returns true if the given window is a top-level one. Currently all frames and dialogs are always considered to be top-level windows (even if they have a parent window).
See GetLabel and SetLabel
See GetLabelText
See GetLastPosition
Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See SetAutoLayout: when auto layout is on, this function gets called automatically by the default EVT_SIZE handler when the window is resized.
See GetLayoutDirection and SetLayoutDirection
This is just a wrapper for ScrollLines(1).
This is just a wrapper for ScrollLines(-1).
Lowers the window to the bottom of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect.
See GetMaxHeight
See GetMaxSize and SetMaxSize
See GetMaxWidth
See GetMinHeight
See GetMinSize and SetMinSize
See GetMinWidth
Moves the window to the given position.
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.
Same as MoveAfterInTabOrder except that it inserts this window just before win instead of putting it right after it.
Moves the window to the given position.
See GetName and SetName
Does keyboard navigation from this window to another, by sending a wx.NavigationKeyEvent.
Generate a control id for the controls which were not given one.
Get the id of the control following the one with the given autogenerated) id
See GetNextHandler and SetNextHandler
See GetNumberOfLines
This is just a wrapper for ScrollPages(1).
This is just a wrapper for ScrollPages(-1).
See GetParent
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, and None will be returned instead.
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.
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.
See GetPosition and SetPosition
Phase 3 of the 2-phase create <wink!> Call this method after precreating the window with the 2-phase create method.
Call this function to prepare the device context for drawing a scrolled image. It sets the device origin according to the current scroll position.
Get the id of the control preceding the one with the given autogenerated) id
See GetPreviousHandler and SetPreviousHandler
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. (In other words, is able to dispatch the events to a 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. 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.
Raises the window to the top of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
See GetRect and SetRect
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 to the window.
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.
Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window will receive a hotkey event. It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application. To bind an event handler function to this hotkey use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the hotkey was registered successfully.
Releases mouse input captured with wx.Window.CaptureMouse.
Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer.
Find the given handler in the event handler chain and remove (but not 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.)
Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) and then re-inserted into another. Available on Windows and GTK. Returns True if the parent was changed, False otherwise (error or newParent == oldParent)
See GetScreenPosition
See GetScreenRect
Converts from screen to client window coordinates.
Converts from screen to client window coordinates.
If the platform and window class supports it, scrolls the window by the given number of lines down, if lines is positive, or up if lines is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
If the platform and window class supports it, scrolls the window by the given number of pages down, if pages is positive, or up if pages is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
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.
See GetSelection and SetSelection
Sets the accelerator table for this window.
Determines whether the Layout function will be called automatically 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.
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. Using wx.NullColour will reset the window to the default background colour.
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.
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.
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 |
|---|
Use SetInitialSize
Sets the caret associated with the window.
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
Sets the window to have the given layout constraints. If an existing layout constraints object is already owned by the window, it will be deleted. Pass None to disassociate and delete the window’s current constraints.
You must call SetAutoLayout to tell a window to use the constraints automatically in its default EVT_SIZE handler; otherwise, you must handle EVT_SIZE yourself and call Layout() explicitly. When setting both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have effect.
This normally does not need to be called by application code. It is called internally when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed.
Sets the window’s cursor. Notice that the window cursor also sets it for the children of the window implicitly.
The cursor may be wx.NullCursor in which case the window cursor will be reset back to default.
Sets the position and size of the window in pixels. The sizeFlags parameter indicates the interpretation of the other params if they are equal to -1.
wx.SIZE_AUTO A -1 indicates that a class-specific default should 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.
Put the native window into double buffered or composited mode.
Associates a drop target with this window. If the window already has a drop target, it is deleted.
Sets the event handler for this window. An event handler is an object 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 off to the next one in the chain.
Sets the extra style bits for the window. Extra styles are the less often used style bits which can’t be set with the constructor or with SetWindowStyleFlag()
Set’s the focus to this window, allowing it to receive keyboard input.
Set focus to this window as the result of a keyboard action. Normally only called internally.
Sets the font for this window.
Sets the foreground colour of the window. Returns True is the colour was changed. 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.
Sets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current wx.HelpProvider implementation, and not in the window object itself.
Associate this help text with all windows with the same id as this one.
Sets the identifier of the window. Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
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.
Set the text which the window shows in its label if applicable.
Set the layout direction (LTR or RTL) for this window.
A more convenient method than SetSizeHints for setting just the max size.
A more convenient method than SetSizeHints for setting just the min size.
Sets the window’s name. The window name is used for ressource setting in X, it is not the same as the window title/label
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
Sets the position and size of the window in pixels using a wx.Rect.
Sets the position of one of the built-in scrollbars.
Sets the scrollbar properties of a built-in scrollbar.
Sets the size of the window in pixels.
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 (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.
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 (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.
Sets the size of the window in pixels.
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-None, and False otherwise.
The same as SetSizer, except it also sets the size hints for the window based on the sizer’s minimum size.
Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best.
Attach a tooltip to the window.
Attach a tooltip to the window.
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.
Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type.
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 windows it is more or less independent of the screen window size.
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.
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.
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 windows it is more or less independent of the screen window size.
SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
Sets the variant of the window/font size to use for this window, if the platform supports variants, for example, wxMac.
Return true from here to allow the colours of this window to be changed by InheritAttributes, returning false forbids inheriting them from the parent window.
The base class version returns false, but this method is overridden in wxControl where it returns 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 the window has been shown or hidden or False if nothing was done because it already was in the requested state.
See IsShown and Show
See GetSize and SetSize
See GetSizer and SetSizer
See GetStringSelection
Reenables window updating after a previous call to Freeze. Calls to Freeze/Thaw may be nested, so Thaw must be called the same number of times that Freeze was before the window will be updated.
See GetThemeEnabled and SetThemeEnabled
Turn the flag on if it had been turned off before and vice versa, returns True if the flag is turned on by this function call.
See GetToolTip and SetToolTip
See IsTopLevel
See GetTopLevelParent
Transfers values from child controls to data areas specified by their validators. Returns false if a transfer failed. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows.
Transfers values to child controls from data areas specified by their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows.
Disconnects the event handler binding for event from self. Returns True if successful.
Unregisters a system wide hotkey.
Calling this method immediately repaints the invalidated area of the 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 first if you want to immediately redraw the window (or some portion of it) unconditionally.
See GetUpdateClientRect
See GetUpdateRegion
This function sends EVT_UPDATE_UI events to the window. The particular implementation depends on the window; for example a wx.ToolBar will send an update UI event for each toolbar button, and a wx.Frame will send an update UI event for each menubar menu item. You can call this 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 limit the overhead that wxWindows incurs by sending update UI events in idle time.
Validates the current values of the child controls using their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. Returns false if any of the validations failed.
See GetValidator and SetValidator
See GetValue and SetValue
See GetVirtualSize and SetVirtualSize
Moves the pointer to the given position on the window.
NOTE: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically.
See GetWindowStyle and SetWindowStyle
See GetWindowStyleFlag and SetWindowStyleFlag
See GetWindowVariant and SetWindowVariant
alias of type
x.__delattr__(‘name’) <==> del x.name
x.__getattribute__(‘name’) <==> x.name
x.__hash__() <==> hash(x)
helper for pickle
helper for pickle
x.__setattr__(‘name’, value) <==> x.name = value
x.__str__() <==> str(x)
list of weak references to the object (if defined)
Prevent further handling of the mouse event by not calling Skip().
The membership flag
Bases: sans.perspectives.fitting.fitpage.FitPage
See GetAcceleratorTable and SetAcceleratorTable
Can this window have focus?
Can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it.
Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer.
Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.
Associate the window with a new native handle
See GetAutoLayout and SetAutoLayout
See GetBackgroundColour and SetBackgroundColour
See GetBackgroundStyle and SetBackgroundStyle
See GetBestSize
See GetBestVirtualSize
Bind an event to an event handler.
| Parameters: |
|
|---|
See GetBorder
Cache the best size so it doesn’t need to be calculated again, (at least until some properties of the window change.)
CalcScrolledPosition(int x, int y) -> (sx, sy)
Translate between scrolled and unscrolled coordinates.
CalcUnscrolledPosition(int x, int y) -> (ux, uy)
Translate between scrolled and unscrolled coordinates.
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.
Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture.
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 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.
See GetCaret and SetCaret
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may 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.
Center with respect to the the parent window
Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may 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.
CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
See GetCharHeight
See GetCharWidth
See GetChildren
See GetClassName
Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated.
See GetClientAreaOrigin
See GetClientRect and SetClientRect
See GetClientSize and SetClientSize
Converts to screen coordinates from coordinates relative to this window.
Converts to screen coordinates from coordinates relative to this window.
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 handler will be allowed to veto the destruction of the window.
See GetConstraints and SetConstraints
See GetContainingSizer and SetContainingSizer
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
Create the GUI part of the Window for 2-phase creation mode.
See GetCursor and SetCursor
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
See GetDefaultAttributes
Destroys the window safely. Frames and dialogs are not destroyed immediately when this function is called – they are added to a list of windows to be deleted on idle time, when all the window’s events have been processed. This prevents problems with events being sent to non-existent windows.
Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
Destroys all children of a window. Called automatically by the destructor.
Disables the window, same as Enable(false).
Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, PyObject func=None) -> bool
Dissociate the current native handle from the window
Normally what is called by PrepareDC.
Enables or disables eligibility for drop file events, EVT_DROP_FILES.
See GetDropTarget and SetDropTarget
See GetEffectiveMinSize
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 has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.
See IsEnabled and Enable
See GetEventHandler and SetEventHandler
See GetEvtHandlerEnabled and SetEvtHandlerEnabled
See GetExtraStyle and SetExtraStyle
Returns the window or control that currently has the keyboard focus, or None.
Find a child of this window by window ID
Find a child of this window by label
Find a child of this window by name
Sizes the window so that it fits around its subwindows. This function won’t do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit.
Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won’t do anything if there are no subwindows.
See GetFont and SetFont
See GetForegroundColour and SetForegroundColour
Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw being delayed until all the nesting has been undone.
This method is useful for visual appearance optimization (for example, 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.
Gets the accelerator table for this window.
Use GetEffectiveMinSize instead.
Returns the current autoLayout setting
Returns the background colour of the window.
Returns the background style of the window.
| See : | SetBackgroundStyle |
|---|
Use GetEffectiveMinSize instead.
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 (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
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 (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
GetBorder(self) -> int
Get border for the flags of this window
Returns the window which currently captures the mouse or None
Returns the caret associated with the window.
Get the (average) character size for the current font.
Get the (average) character size for the current font.
Returns an object containing a list of the window’s children. The object provides a Python sequence-like interface over the internal list maintained by the window..
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 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 wx.Window.SetWindowVariant for more about this.
Returns the class name of the C++ class using wxRTTI.
Get the origin of the client area of the window relative to the window’s top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)
Get the client area position and size as a wx.Rect object.
This gets the size of the window’s ‘client area’ in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
This gets the size of the window’s ‘client area’ in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
Returns a pointer to the window’s layout constraints, or None if there are none.
Return the sizer that this window is a member of, if any, otherwise None.
Return the cursor associated with this window.
Returns the associated drop target, which may be None.
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.
Returns the event handler for this window. By default, the window is its own event handler.
Returns the extra style bits for the window.
Returns the default font used for this window.
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.
(width, height, descent, externalLeading)
Get the width, height, decent and leading of the text using the current or specified font.
Returns the parent of the parent of this window, or None if there isn’t one.
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
Returns the platform-specific handle (as a long integer) of the physical window. On wxMSW this is the win32 window handle, on wxGTK it is the XWindow ID, and on wxMac it is the ControlRef.
Gets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current wx.HelpProvider implementation, and not in the window object itself.
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
Returns the identifier of the window. Each window has an integer identifier. If the application has not provided one (or the default Id -1 is used) then an unique identifier with a negative value will be generated.
Generic way of getting a label from any window, for identification purposes. The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs such as testing tools or special-needs access programs)which need to identify windows by name.
Get the layout direction (LTR or RTL) for this window. Returns wx.Layout_Default if layout direction is not supported.
Returns the windows name. This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via wx.Window.SetName.
Returns the parent window of this window, or None if there isn’t one.
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.
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.
Returns the size and position of the window as a wx.Rect object.
Get the position of the window in screen coordinantes.
Get the position of the window in screen coordinantes.
Returns the size and position of the window in screen coordinantes as a wx.Rect object.
Get the size of one logical unit in physical units.
Returns the built-in scrollbar position.
Returns the built-in scrollbar range.
Returns the built-in scrollbar thumb size.
Get the window size.
Get the window size.
Return the sizer associated with the window by a previous call to SetSizer or None if there isn’t one.
Get the width and height of the text using the current font.
Return the themeEnabled flag.
get the associated tooltip or None if none
Returns the first frame or dialog in this window’s parental hierarchy.
Get the update rectangle region bounding box in client coords.
Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler.
Returns a pointer to the current validator for the window, or None if there is none.
Get the view start
Get the the virtual size of the window in pixels. For most windows this 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.
Get the the virtual size of the window in pixels. For most windows this 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.
Return the size of the left/right and top/bottom borders.
GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create method.
Gets the window style that was passed to the constructor or Create method.
See GetGrandParent
GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
See GetHandle
Returns true if this window has the current mouse capture.
Test if the given style is set for this window.
Does the window have the scrollbar for this orientation?
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.
See GetHelpText and SetHelpText
Equivalent to calling Show(False).
Test where the given (in client coords) point lies
Test where the given (in client coords) point lies
See GetId and SetId
This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.
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 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 no matter what and only the font might.
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 parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes.
Sends an EVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.
Reset the cached best size value so it will be recalculated the next time it is needed.
Is the window in the process of being deleted?
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.
Returns true if the window is enabled for input, false otherwise.
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
Returns True if the window has been frozen and not thawed yet.
| See : | Freeze and Thaw |
|---|
Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms.
For wx.Objects that use C++ reference counting internally, this method can be used to determine if two objects are referencing the same data object.
Returns true if the window is shown, false if it has been hidden.
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.
Returns true if the given window is a top-level one. Currently all frames and dialogs are always considered to be top-level windows (even if they have a parent window).
See GetLabel and SetLabel
Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See SetAutoLayout: when auto layout is on, this function gets called automatically by the default EVT_SIZE handler when the window is resized.
See GetLayoutDirection and SetLayoutDirection
This is just a wrapper for ScrollLines(1).
This is just a wrapper for ScrollLines(-1).
Lowers the window to the bottom of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect.
See GetMaxHeight
See GetMaxSize and SetMaxSize
See GetMaxWidth
See GetMinHeight
See GetMinSize and SetMinSize
See GetMinWidth
Bases: wx._controls.TextCtrl
Text control for model and fit parameters. Binds the appropriate events for user interactions. Default callback methods can be overwritten on initialization
| Parameters: |
|
|---|
See GetAcceleratorTable and SetAcceleratorTable
Can this window have focus?
Can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it.
Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer.
Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.
See GetAlignment
Associate the window with a new native handle
See GetAutoLayout and SetAutoLayout
See GetBackgroundColour and SetBackgroundColour
See GetBackgroundStyle and SetBackgroundStyle
See GetBestSize
See GetBestVirtualSize
Bind an event to an event handler.
| Parameters: |
|
|---|
See GetBorder
Cache the best size so it doesn’t need to be calculated again, (at least until some properties of the window change.)
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.
Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture.
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 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.
See GetCaret and SetCaret
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may 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.
Center with respect to the the parent window
Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may 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.
CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
See GetCharHeight
See GetCharWidth
See GetChildren
See GetClassName
Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated.
See GetClientAreaOrigin
See GetClientRect and SetClientRect
See GetClientSize and SetClientSize
Converts to screen coordinates from coordinates relative to this window.
Converts to screen coordinates from coordinates relative to this window.
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 handler will be allowed to veto the destruction of the window.
Simulates the effect of the user issuing a command to the item.
| See : | wx.CommandEvent |
|---|
See GetConstraints and SetConstraints
See GetContainingSizer and SetContainingSizer
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
Create(self, Window parent, int id=-1, String value=EmptyString, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, String name=TextCtrlNameStr) -> bool
See GetCursor and SetCursor
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog’s proportions even if the font changes. For the x dimension, the dialog units are multiplied by the 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.
See GetDefaultAttributes
See GetDefaultStyle and SetDefaultStyle
Destroys the window safely. Frames and dialogs are not destroyed immediately when this function is called – they are added to a list of windows to be deleted on idle time, when all the window’s events have been processed. This prevents problems with events being sent to non-existent windows.
Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
Destroys all children of a window. Called automatically by the destructor.
Disables the window, same as Enable(false).
Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, PyObject func=None) -> bool
Dissociate the current native handle from the window
Enables or disables eligibility for drop file events, EVT_DROP_FILES.
See GetDropTarget and SetDropTarget
See GetEffectiveMinSize
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 has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.
See IsEnabled and Enable
See GetEventHandler and SetEventHandler
See GetEvtHandlerEnabled and SetEvtHandlerEnabled
See GetExtraStyle and SetExtraStyle
Returns the window or control that currently has the keyboard focus, or None.
Find a child of this window by window ID
Find a child of this window by label
Find a child of this window by name
Sizes the window so that it fits around its subwindows. This function won’t do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit.
Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won’t do anything if there are no subwindows.
See GetFont and SetFont
See GetForegroundColour and SetForegroundColour
Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw being delayed until all the nesting has been undone.
This method is useful for visual appearance optimization (for example, 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.
Gets the accelerator table for this window.
Use GetEffectiveMinSize instead.
Get the control alignment (left/right/centre, top/bottom/centre)
Returns the current autoLayout setting
Returns the background colour of the window.
Returns the background style of the window.
| See : | SetBackgroundStyle |
|---|
Use GetEffectiveMinSize instead.
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 (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
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 (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
GetBorder(self) -> int
Get border for the flags of this window
Returns the window which currently captures the mouse or None
Returns the caret associated with the window.
Get the (average) character size for the current font.
Get the (average) character size for the current font.
Returns an object containing a list of the window’s children. The object provides a Python sequence-like interface over the internal list maintained by the window..
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 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 wx.Window.SetWindowVariant for more about this.
Returns the class name of the C++ class using wxRTTI.
Get the origin of the client area of the window relative to the window’s top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)
Get the client area position and size as a wx.Rect object.
This gets the size of the window’s ‘client area’ in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
This gets the size of the window’s ‘client area’ in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
Returns a pointer to the window’s layout constraints, or None if there are none.
Return the sizer that this window is a member of, if any, otherwise None.
Return the cursor associated with this window.
Get the default attributes for an instance of 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 user’s system, especially if it uses themes.
Returns the associated drop target, which may be None.
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.
Returns the event handler for this window. By default, the window is its own event handler.
Returns the extra style bits for the window.
Returns the default font used for this window.
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.
(width, height, descent, externalLeading)
Get the width, height, decent and leading of the text using the current or specified font.
Returns the parent of the parent of this window, or None if there isn’t one.
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
Returns the platform-specific handle (as a long integer) of the physical window. On wxMSW this is the win32 window handle, on wxGTK it is the XWindow ID, and on wxMac it is the ControlRef.
Gets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current wx.HelpProvider implementation, and not in the window object itself.
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
Returns the identifier of the window. Each window has an integer identifier. If the application has not provided one (or the default Id -1 is used) then an unique identifier with a negative value will be generated.
Generic way of getting a label from any window, for identification purposes. The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs such as testing tools or special-needs access programs)which need to identify windows by name.
Get just the text of the label, without mnemonic characters (‘&’)
Get the layout direction (LTR or RTL) for this window. Returns wx.Layout_Default if layout direction is not supported.
Returns the windows name. This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via wx.Window.SetName.
Returns the parent window of this window, or None if there isn’t one.
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.
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.
Returns the size and position of the window as a wx.Rect object.
Get the position of the window in screen coordinantes.
Get the position of the window in screen coordinantes.
Returns the size and position of the window in screen coordinantes as a wx.Rect object.
Returns the built-in scrollbar position.
Returns the built-in scrollbar range.
Returns the built-in scrollbar thumb size.
If the return values from and to are the same, there is no selection.
Get the window size.
Get the window size.
Return the sizer associated with the window by a previous call to SetSizer or None if there isn’t one.
Get the width and height of the text using the current font.
Return the themeEnabled flag.
get the associated tooltip or None if none
Returns the first frame or dialog in this window’s parental hierarchy.
Get the update rectangle region bounding box in client coords.
Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler.
Returns a pointer to the current validator for the window, or None if there is none.
Get the the virtual size of the window in pixels. For most windows this 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.
Get the the virtual size of the window in pixels. For most windows this 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.
Return the size of the left/right and top/bottom borders.
GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create method.
Gets the window style that was passed to the constructor or Create method.
See GetGrandParent
GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
See GetHandle
Returns true if this window has the current mouse capture.
Test if the given style is set for this window.
Does the window have the scrollbar for this orientation?
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.
See GetHelpText and SetHelpText
Equivalent to calling Show(False).
Find the row, col coresponding to the character at the point given in pixels. NB: pt is in device coords but is not adjusted for the client area origin nor scrolling.
Find the character position in the text coresponding to the point given in pixels. NB: pt is in device coords but is not adjusted for the client area origin nor scrolling.
Test where the given (in client coords) point lies
See GetId and SetId
This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.
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 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 no matter what and only the font might.
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 parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes.
Sends an EVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.
See GetInsertionPoint and SetInsertionPoint
Reset the cached best size value so it will be recalculated the next time it is needed.
Is the window in the process of being deleted?
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.
Returns true if the window is enabled for input, false otherwise.
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
Returns True if the window has been frozen and not thawed yet.
| See : | Freeze and Thaw |
|---|
Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms.
For wx.Objects that use C++ reference counting internally, this method can be used to determine if two objects are referencing the same data object.
Returns true if the window is shown, false if it has been hidden.
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.
Returns true if the given window is a top-level one. Currently all frames and dialogs are always considered to be top-level windows (even if they have a parent window).
See GetLabel and SetLabel
See GetLabelText
See GetLastPosition
Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See SetAutoLayout: when auto layout is on, this function gets called automatically by the default EVT_SIZE handler when the window is resized.
See GetLayoutDirection and SetLayoutDirection
This is just a wrapper for ScrollLines(1).
This is just a wrapper for ScrollLines(-1).
Lowers the window to the bottom of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect.
See GetMaxHeight
See GetMaxSize and SetMaxSize
See GetMaxWidth
See GetMinHeight
See GetMinSize and SetMinSize
See GetMinWidth
Moves the window to the given position.
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.
Same as MoveAfterInTabOrder except that it inserts this window just before win instead of putting it right after it.
Moves the window to the given position.
See GetName and SetName
Does keyboard navigation from this window to another, by sending a wx.NavigationKeyEvent.
Generate a control id for the controls which were not given one.
Get the id of the control following the one with the given autogenerated) id
See GetNextHandler and SetNextHandler
See GetNumberOfLines
This is just a wrapper for ScrollPages(1).
This is just a wrapper for ScrollPages(-1).
See GetParent
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, and None will be returned instead.
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.
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.
See GetPosition and SetPosition
Phase 3 of the 2-phase create <wink!> Call this method after precreating the window with the 2-phase create method.
Call this function to prepare the device context for drawing a scrolled image. It sets the device origin according to the current scroll position.
Get the id of the control preceding the one with the given autogenerated) id
See GetPreviousHandler and SetPreviousHandler
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. (In other words, is able to dispatch the events to a 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. 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.
Raises the window to the top of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
See GetRect and SetRect
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 to the window.
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.
Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window will receive a hotkey event. It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application. To bind an event handler function to this hotkey use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the hotkey was registered successfully.
Releases mouse input captured with wx.Window.CaptureMouse.
Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer.
Find the given handler in the event handler chain and remove (but not 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.)
Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) and then re-inserted into another. Available on Windows and GTK. Returns True if the parent was changed, False otherwise (error or newParent == oldParent)
See GetScreenPosition
See GetScreenRect
Converts from screen to client window coordinates.
Converts from screen to client window coordinates.
If the platform and window class supports it, scrolls the window by the given number of lines down, if lines is positive, or up if lines is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
If the platform and window class supports it, scrolls the window by the given number of pages down, if pages is positive, or up if pages is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
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.
See GetSelection and SetSelection
Sets the accelerator table for this window.
Determines whether the Layout function will be called automatically 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.
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. Using wx.NullColour will reset the window to the default background colour.
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.
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.
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 |
|---|
Use SetInitialSize
Sets the caret associated with the window.
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
Sets the window to have the given layout constraints. If an existing layout constraints object is already owned by the window, it will be deleted. Pass None to disassociate and delete the window’s current constraints.
You must call SetAutoLayout to tell a window to use the constraints automatically in its default EVT_SIZE handler; otherwise, you must handle EVT_SIZE yourself and call Layout() explicitly. When setting both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have effect.
This normally does not need to be called by application code. It is called internally when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed.
Sets the window’s cursor. Notice that the window cursor also sets it for the children of the window implicitly.
The cursor may be wx.NullCursor in which case the window cursor will be reset back to default.
Sets the position and size of the window in pixels. The sizeFlags parameter indicates the interpretation of the other params if they are equal to -1.
wx.SIZE_AUTO A -1 indicates that a class-specific default should 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.
Put the native window into double buffered or composited mode.
Associates a drop target with this window. If the window already has a drop target, it is deleted.
Sets the event handler for this window. An event handler is an object 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 off to the next one in the chain.
Sets the extra style bits for the window. Extra styles are the less often used style bits which can’t be set with the constructor or with SetWindowStyleFlag()
Set’s the focus to this window, allowing it to receive keyboard input.
Set focus to this window as the result of a keyboard action. Normally only called internally.
Sets the font for this window.
Sets the foreground colour of the window. Returns True is the colour was changed. 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.
Sets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current wx.HelpProvider implementation, and not in the window object itself.
Associate this help text with all windows with the same id as this one.
Sets the identifier of the window. Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
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.
Set the text which the window shows in its label if applicable.
Set the layout direction (LTR or RTL) for this window.
A more convenient method than SetSizeHints for setting just the max size.
A more convenient method than SetSizeHints for setting just the min size.
Sets the window’s name. The window name is used for ressource setting in X, it is not the same as the window title/label
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
Sets the position and size of the window in pixels using a wx.Rect.
Sets the position of one of the built-in scrollbars.
Sets the scrollbar properties of a built-in scrollbar.
Sets the size of the window in pixels.
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 (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.
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 (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.
Sets the size of the window in pixels.
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-None, and False otherwise.
The same as SetSizer, except it also sets the size hints for the window based on the sizer’s minimum size.
Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best.
Attach a tooltip to the window.
Attach a tooltip to the window.
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.
Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type.
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 windows it is more or less independent of the screen window size.
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.
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.
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 windows it is more or less independent of the screen window size.
SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
Sets the variant of the window/font size to use for this window, if the platform supports variants, for example, wxMac.
Return true from here to allow the colours of this window to be changed by InheritAttributes, returning false forbids inheriting them from the parent window.
The base class version returns false, but this method is overridden in wxControl where it returns 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 the window has been shown or hidden or False if nothing was done because it already was in the requested state.
See IsShown and Show
See GetSize and SetSize
See GetSizer and SetSizer
See GetStringSelection
Reenables window updating after a previous call to Freeze. Calls to Freeze/Thaw may be nested, so Thaw must be called the same number of times that Freeze was before the window will be updated.
See GetThemeEnabled and SetThemeEnabled
Turn the flag on if it had been turned off before and vice versa, returns True if the flag is turned on by this function call.
See GetToolTip and SetToolTip
See IsTopLevel
See GetTopLevelParent
Transfers values from child controls to data areas specified by their validators. Returns false if a transfer failed. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows.
Transfers values to child controls from data areas specified by their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows.
Disconnects the event handler binding for event from self. Returns True if successful.
Unregisters a system wide hotkey.
Calling this method immediately repaints the invalidated area of the 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 first if you want to immediately redraw the window (or some portion of it) unconditionally.
See GetUpdateClientRect
See GetUpdateRegion
This function sends EVT_UPDATE_UI events to the window. The particular implementation depends on the window; for example a wx.ToolBar will send an update UI event for each toolbar button, and a wx.Frame will send an update UI event for each menubar menu item. You can call this 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 limit the overhead that wxWindows incurs by sending update UI events in idle time.
Validates the current values of the child controls using their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. Returns false if any of the validations failed.
See GetValidator and SetValidator
See GetValue and SetValue
See GetVirtualSize and SetVirtualSize
Moves the pointer to the given position on the window.
NOTE: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically.
See GetWindowStyle and SetWindowStyle
See GetWindowStyleFlag and SetWindowStyleFlag
See GetWindowVariant and SetWindowVariant
alias of type
x.__delattr__(‘name’) <==> del x.name
x.__getattribute__(‘name’) <==> x.name
x.__hash__() <==> hash(x)
helper for pickle
helper for pickle
x.__setattr__(‘name’, value) <==> x.name = value
x.__str__() <==> str(x)
list of weak references to the object (if defined)
Highlight text of a TextCtrl only of no text has be selected
| Parameters: | event – mouse event |
|---|
Catch when the text control is set in focus to highlight the whole text if necessary
| Parameters: | event – mouse event |
|---|
Save the state of the page
The membership flag
Moves the window to the given position.
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.
Same as MoveAfterInTabOrder except that it inserts this window just before win instead of putting it right after it.
Moves the window to the given position.
See GetName and SetName
Does keyboard navigation from this window to another, by sending a wx.NavigationKeyEvent.
Generate a control id for the controls which were not given one.
Get the id of the control following the one with the given autogenerated) id
See GetNextHandler and SetNextHandler
This is just a wrapper for ScrollPages(1).
This is just a wrapper for ScrollPages(-1).
See GetParent
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, and None will be returned instead.
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.
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.
See GetPosition and SetPosition
Phase 3 of the 2-phase create <wink!> Call this method after precreating the window with the 2-phase create method.
Call this function to prepare the device context for drawing a scrolled image. It sets the device origin according to the current scroll position.
Get the id of the control preceding the one with the given autogenerated) id
See GetPreviousHandler and SetPreviousHandler
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. (In other words, is able to dispatch the events to a 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. 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.
Raises the window to the top of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
See GetRect and SetRect
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 to the window.
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.
Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window will receive a hotkey event. It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application. To bind an event handler function to this hotkey use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the hotkey was registered successfully.
Releases mouse input captured with wx.Window.CaptureMouse.
Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer.
Find the given handler in the event handler chain and remove (but not 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.)
Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) and then re-inserted into another. Available on Windows and GTK. Returns True if the parent was changed, False otherwise (error or newParent == oldParent)
See GetScaleX
See GetScaleY
See GetScreenPosition
See GetScreenRect
Converts from screen to client window coordinates.
Converts from screen to client window coordinates.
Scrolls the panel such that the specified child window is in view.
If the platform and window class supports it, scrolls the window by the given number of lines down, if lines is positive, or up if lines is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
If the platform and window class supports it, scrolls the window by the given number of pages down, if pages is positive, or up if pages is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
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.
Sets the accelerator table for this window.
Determines whether the Layout function will be called automatically 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.
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. Using wx.NullColour will reset the window to the default background colour.
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.
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.
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 |
|---|
Use SetInitialSize
SetInitialSize(self, Size size=DefaultSize)
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.
Sets the caret associated with the window.
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
Sets the window to have the given layout constraints. If an existing layout constraints object is already owned by the window, it will be deleted. Pass None to disassociate and delete the window’s current constraints.
You must call SetAutoLayout to tell a window to use the constraints automatically in its default EVT_SIZE handler; otherwise, you must handle EVT_SIZE yourself and call Layout() explicitly. When setting both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have effect.
This normally does not need to be called by application code. It is called internally when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed.
Sets the window’s cursor. Notice that the window cursor also sets it for the children of the window implicitly.
The cursor may be wx.NullCursor in which case the window cursor will be reset back to default.
Sets the position and size of the window in pixels. The sizeFlags parameter indicates the interpretation of the other params if they are equal to -1.
wx.SIZE_AUTO A -1 indicates that a class-specific default should 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.
Put the native window into double buffered or composited mode.
Associates a drop target with this window. If the window already has a drop target, it is deleted.
Sets the event handler for this window. An event handler is an object 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 off to the next one in the chain.
Sets the extra style bits for the window. Extra styles are the less often used style bits which can’t be set with the constructor or with SetWindowStyleFlag()
Set’s the focus to this window, allowing it to receive keyboard input.
Set focus to this window as the result of a keyboard action. Normally only called internally.
In contrast to SetFocus (see above) this will set the focus to the panel even of there are child windows in the panel. This is only rarely needed.
Sets the font for this window.
Sets the foreground colour of the window. Returns True is the colour was changed. 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.
Sets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current wx.HelpProvider implementation, and not in the window object itself.
Associate this help text with all windows with the same id as this one.
Sets the identifier of the window. Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
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.
Set the text which the window shows in its label if applicable.
Set the layout direction (LTR or RTL) for this window.
A more convenient method than SetSizeHints for setting just the max size.
A more convenient method than SetSizeHints for setting just the min size.
Sets the window’s name. The window name is used for ressource setting in X, it is not the same as the window title/label
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
Sets the position and size of the window in pixels using a wx.Rect.
Sets the position of one of the built-in scrollbars.
Sets the scrollbar properties of a built-in scrollbar.
SetScrollbars(self, int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX, int noUnitsY, int xPos=0, int yPos=0, bool noRefresh=False)
Sets the size of the window in pixels.
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 (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.
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 (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.
Sets the size of the window in pixels.
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-None, and False otherwise.
The same as SetSizer, except it also sets the size hints for the window based on the sizer’s minimum size.
Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best.
Attach a tooltip to the window.
Attach a tooltip to the window.
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.
Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type.
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 windows it is more or less independent of the screen window size.
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.
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.
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 windows it is more or less independent of the screen window size.
SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
Sets the variant of the window/font size to use for this window, if the platform supports variants, for example, wxMac.
This function sets up the event handling necessary to handle scrolling properly. It should be called within the __init__ function of any class that is derived from ScrolledPanel, once the controls on the panel have been constructed and thus the size of the scrolling area can be determined.
Return true from here to allow the colours of this window to be changed by InheritAttributes, returning false forbids inheriting them from the parent window.
The base class version returns false, but this method is overridden in wxControl where it returns 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 the window has been shown or hidden or False if nothing was done because it already was in the requested state.
See IsShown and Show
See GetSize and SetSize
See GetSizer and SetSizer
See GetTargetWindow and SetTargetWindow
Reenables window updating after a previous call to Freeze. Calls to Freeze/Thaw may be nested, so Thaw must be called the same number of times that Freeze was before the window will be updated.
See GetThemeEnabled and SetThemeEnabled
Turn the flag on if it had been turned off before and vice versa, returns True if the flag is turned on by this function call.
See GetToolTip and SetToolTip
See IsTopLevel
See GetTopLevelParent
Transfers values from child controls to data areas specified by their validators. Returns false if a transfer failed. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows.
Transfers values to child controls from data areas specified by their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows.
Disconnects the event handler binding for event from self. Returns True if successful.
Unregisters a system wide hotkey.
Calling this method immediately repaints the invalidated area of the 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 first if you want to immediately redraw the window (or some portion of it) unconditionally.
See GetUpdateClientRect
See GetUpdateRegion
This function sends EVT_UPDATE_UI events to the window. The particular implementation depends on the window; for example a wx.ToolBar will send an update UI event for each toolbar button, and a wx.Frame will send an update UI event for each menubar menu item. You can call this 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 limit the overhead that wxWindows incurs by sending update UI events in idle time.
Validates the current values of the child controls using their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. Returns false if any of the validations failed.
See GetValidator and SetValidator
See GetViewStart
See GetVirtualSize and SetVirtualSize
Moves the pointer to the given position on the window.
NOTE: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically.
See GetWindowStyle and SetWindowStyle
See GetWindowStyleFlag and SetWindowStyleFlag
See GetWindowVariant and SetWindowVariant
Stop fit
alias of type
x.__delattr__(‘name’) <==> del x.name
x.__getattribute__(‘name’) <==> x.name
x.__hash__() <==> hash(x)
Initialization of the Panel
helper for pickle
helper for pickle
x.__setattr__(‘name’, value) <==> x.name = value
x.__str__() <==> str(x)
list of weak references to the object (if defined)
Back to bookmark
| Parameters: | list – model parameter and panel info |
|---|---|
| Note : | each item of the list should be as follow: item=[check button state, parameter’s name,
|
hide the error text control shown after fitting
Send event dpemding on flag
: Param flag: flag that distinguish event
copy the state of button
| Parameters: |
|
|---|
Create default data for fitting perspective Only when the page is on theory mode. :warning: This data is never plotted.
Create 2D data by default Only when the page is on theory mode. :warning: This data is never plotted.
Reset array dispersion
| Parameters: | name – name of the parameter for the dispersion to be set |
|---|
Draw model image w/mask
Method to draw or refresh a plotted model. The method will use the data member from the model page to build a call to the fitting perspective manager.
| Parameters: | chisqr – update chisqr value [bool] |
|---|
Method to draw or refresh a plotted model. The method will use the data member from the model page to build a call to the fitting perspective manager.
| Parameters: | chisqr – update chisqr value [bool] |
|---|
fill sizer 0 with data info
fill sizer containing model info
Fill the sizer containing the plotting range add access to npts
FInd Comboox selection from disp_func
| Parameters: | disp_function – dispersion distr. function |
|---|
Helping get value and name of the params
: param param: parameters : param orient_param = oritational params : return content: strings [list] [name,value:....]
Get the defult values for custum smearing.
Helping set values of the params
: param param: parameters : param orient_param: oritational params : param content: dictionary [ name, value: name1.value1,...]
Get the smear info from data.
| Returns: | self.smear_type, self.dq_l and self.dq_r, respectively the type of the smear, dq_min and dq_max for pinhole smear data while dxl and dxw for slit smear |
|---|
return time and date stings
Hide all smearing messages in the set_smearer sizer
Hide the comboBox of muitfactor of CoreMultiShellModel
Check if data_name is Data2D
| Returns: | True or False |
|---|
check if any of pinhole smear is changed
| Returns: | True or False |
|---|
check if any of slit lengths is changed
| Returns: | True or False |
|---|
return to self._is_modified
returns self.Layout
| Note : | Mac seems to like this better when self. Layout is called after fitting. |
|---|
Draw a sizer with no dispersity info
Give sleep to MAC
Prevent further handling of the mouse event on Npts_total by not calling Skip().
Update and Draw the model
Allow to fit
Build a panel to allow to edit Mask
toggle view of model from 1D to 2D or 2D from 1D
Check validity of value enter in the Q range field
Select a distribution function for the polydispersion
| Param event: | ComboBox event |
|---|
get the current name of the fit engine type and update the panel accordingly
When fit is complete ,reset the fit button label.
Select an func: Erf,Rparabola,LParabola
allow selecting different dispersion self.disp_list should change type later .now only gaussian
Select an accuracy in 2D custom smear: Xhigh, High, Med, or Low
call back for model selection
call back for model selection
Plot SLD profile
when enter value on panel redraw model according to changed
check if values entered by the user are changed and valid to replot model
Check validity of value enter in the parameters range field
Helps get paste for poly function
| Parameters: |
|
|---|
fill combox box with dict item
| Parameters: | list – contains item to fill the combox item must model class |
|---|
reset the context menu
put gaussian dispersity into current model
Help to rest page for dispersions
Reset the parameters at the given state
Reset the plotting range to a given state
Reset the string parameters at the given state
save the state of plotting range
save radiobutton containing the type model that can be selected
open a dialog file to selected the customized dispersity
Set the list of an accuracy in 2D custum smear: Xhigh, High, Med, or Low
Set array dispersion
| Parameters: |
|
|---|
Set array dispersion model
| Parameters: |
|
|---|
The derivative class sets the bookmark flag value to indicate that it can be bookmarked
The derivative class sets the copy flag value to indicate that the action done can be recovered
respond to self.enable_disp and self.disable_disp radio box. The dispersity object is reset inside the model into Gaussian. When the user select yes , this method display a combo box for more selection when the user selects No,the combo box disappears. Redraw the model with the default dispersity (Gaussian)
Set cb for array disp
The derivative class sets the drag flag value to indicate that dragging motion is possible
Set the list of func for multifunctional models
Display the sizer according to the type of the current model
Set comboBox for muitfactor of CoreMultiShellModel :param multiplicit: no. of multi-functionality
The derivative class sets the paste flag value to indicate that the action done can be recovered
Set custom pinhole smear
| Returns: | msg |
|---|
The derivative class sets the preview flag value to indicate that it can be previewed
The derivative class sets the print flag value to indicate that it can be printed
The derivative class sets the redo flag value to indicate that the action done can be recovered
The derivative class sets the reset flag value to indicate that it can be reset
The derivative class sets the drag flag value to indicate that it can be saved
draw sizer with gaussian dispersity parameters
Set custom slit smear
| Returns: | message to inform the user about the validity of the values entered for slit smear |
|---|
Set semarer radio buttons
The derivative class sets the undo flag value to indicate that the current action done can be canceled
Set weight in fit problem
The derivative class sets the zoom flag value to indicate that it can be zoomed
The derivative class sets the zoom in flag value to indicate that it can be zoomed in
The derivative class sets the zoom out flag value to indicate that it can be zoomed out
Show combox box associate with type of model selected
Fill panel’s combo box according to the type of model selected
Show the comboBox of muitfactor of CoreMultiShellModel
Show only the sizers depending on smear selection
sleep for 1 sec only applied on Mac Note: This 1sec helps for Mac not to crash on self.:ayout after self._draw_model
Check validity of value enter in the Q range field
make sure that update param values just before the fitting
Validate the number of points for fitting is more than 10 points. If valid, setvalues Npts_fit otherwise post msg.
Validate the number of points for fitting is more than 5 points. If valid, setvalues Npts_fit otherwise post msg.
Verify that the Q range controls have valid values and that Qmin < Qmax.
| Parameters: |
|
|---|---|
| Returns: | True is the Q range is value, False otherwise |
Please use PyScrolledWindow.AcceptsFocus instead.
Please use PyScrolledWindow.AcceptsFocusFromKeyboard instead.
Please use PyScrolledWindow.AddChild instead.
Please use PyScrolledWindow.DoGetBestSize instead.
Please use PyScrolledWindow.DoGetClientSize instead.
Please use PyScrolledWindow.DoGetPosition instead.
Please use PyScrolledWindow.DoGetSize instead.
Please use PyScrolledWindow.DoGetVirtualSize instead.
Please use PyScrolledWindow.DoMoveWindow instead.
Please use PyScrolledWindow.DoSetClientSize instead.
Please use PyScrolledWindow.DoSetSize instead.
Please use PyScrolledWindow.DoSetVirtualSize instead.
Please use PyScrolledWindow.Enable instead.
Please use PyScrolledWindow.GetDefaultAttributes instead.
Please use PyScrolledWindow.GetMaxSize instead.
Please use PyScrolledWindow.InitDialog instead.
Please use PyScrolledWindow.OnInternalIdle instead.
Please use PyScrolledWindow.RemoveChild instead.
Please use PyScrolledWindow.ShouldInheritColours instead.
Please use PyScrolledWindow.TransferDataFromWindow instead.
Please use PyScrolledWindow.TransferDataToWindow instead.
Please use PyScrolledWindow.Validate instead.
bind the fit button to either fit handler or stop fit handler
check if the user can already perform some action with this panel
compute the minimum and the maximum range of the data return the npts contains in data :param data:
find the range that include all data in the set return the minimum and the maximum values
return the current state of the page
Given the user selection, creates a 1D or 2D data Only when the page is on theory mode.
Create empty sizer for a panel
Enable or disable data source control depending on existing data
Enable fit button if data is valid and model is valid
Get a list of data and fill the corresponding combobox
Found all parameters current check and add them to list of parameters to fit
Get the bookmark flag to update appropriately the tool bar
return the current chi2
Get strings in the clipboard
Get copy params to clipboard
Get the copy flag to update appropriately the tool bar
Get the string copies of the param names and values in the tap
return the current data
return the current data
Get the drag flag to update appropriately the tool bar
Get the images of the plots corresponding this panel for report
: return graphs: list of figures : TODO: Move to guiframe
return numbers of data points within qrange
| Note : | This is for Park where chi2 is not normalized by Npts of fit |
|---|
| Return self.param_toFit: | |
|---|---|
| list containing references to TextCtrl checked.Theses TextCtrl will allow reference to parameters to fit. | |
| Raise : | if return an empty list of parameter fit will nnote work properly so raise ValueError,”missing parameter to fit” |
Paste params from the clipboard
Get the copy flag to update appropriately the tool bar
Get the string copies of the param names and values in the tap
Get the preview flag to update appropriately the tool bar
Get the print flag to update appropriately the tool bar
return the fitting range
Get the redo flag to update appropriately the tool bar
Get the reset flag to update appropriately the tool bar
Get the save flag to update appropriately the tool bar
Get the undo flag to update appropriately the tool bar
return True if the panel allow 2D or False if 1D
Get flag corresponding to a given weighting dI data.
Get the zoom flag to update appropriately the tool bar
Get the zoom in flag to update appropriately the tool bar
Get the zoom out flag to update appropriately the tool bar
put default value in the combobox
save history of the data and model
Retrieve the state selected state
Create a custom pinhole smear object that will change the way residuals are compute when fitting
| Note : | accuracy is given by strings’High’,’Med’, ‘Low’ FOR 2d, None for 1D |
|---|
Restore the previous action cancelled
Reset model state
highlight the current textcrtl and hide the error text control shown after fitting
Create a custom slit smear object that will change the way residuals are compute when fitting
Create a smear object that will change the way residuals are compute when fitting
Cancel the previous action
On Weighting radio button event, sets the weightbt_string
| Parameters: | event – contains parameter enable . when enable is set to True |
|---|
the application is in Batch mode else the application is default mode(single mode)
save history of the data and model
Display result chisqr on the panel :event: activated by fitting/ complete after draw
Copy Parameter values to the clipboad
The derivative class allows dragging motion if implemented
The derivative class is on unfocus if implemented
Get key stroke event
on ‘More details’ button
Paste Parameter values to the panel if possible
Button event for PD help
Report the current fit results
The previous action is restored if possible
The derivative class state is restored
On ‘Reset’ button for Q range clicked
Get key stroke event
Save the current state into file
On Set Focus, update guimanger and menu
Update menu1 on cliking the page tap
The current action is canceled
The derivative class is on zoom mode (using pane) if zoom mode is implemented
The derivative class is on zoom in mode if implemented
The derivative class is on zoom out mode if implemented
Build the panel from the fit result
| Parameters: |
|
|---|
Store list of model
| Parameters: | dict – dictionary containing list of models |
|---|
Read two columns file
| Parameters: | path – the path to the file to read |
|---|
find a short name for model
reset the state
Use page_state and change the state of existing page
| Precondition : | the page is already drawn or created |
|---|---|
| Postcondition : | the state of the underlying data change as well as the state of the graphic interface |
Currently no save option implemented for batch page
Currently no save option implemented for batch page
return an xml node containing state of the panel that guiframe can write to file
set to true or false all checkBox given the main checkbox value cb1
Select TextCtrl checked for fitting purpose and stores them in self.param_toFit=[] list
Put the string to the clipboard
reset the current data
fill sizer containing dispersity info
Index related to this page
layout
set panel manager
| Parameters: | manager – instance of plugin fitting |
|---|
Build the panel from the model content
| Parameters: | model – the model selected in combo box for fitting purpose |
|---|
reset page given a model state
setValue Npts for fitting
set owner of fitpage
| Parameters: | owner – the class responsible of plotting |
|---|
set some page important information at once
The membership flag
called by kill_focus on pinhole TextCntrl to update the changes
| Returns: | False when wrong value was entered |
|---|
called by kill_focus on pinhole TextCntrl to update the changes
| Returns: | False when wrong value was entered |
|---|