================== wxPython Functions ================== The functions and macros defined in wxPython are described here: you can look up a function using the alphabetical listing of them. Functions Summary ================= `A`_ | `B`_ | `C`_ | `D`_ | `E`_ | `F`_ | `G`_ | `H`_ | `I`_ | `K`_ | `L`_ | `M`_ | `N`_ | `P`_ | `Q`_ | `R`_ | `S`_ | `T`_ | `U`_ | `V`_ | `W`_ | `Y`_ A ^ * `AboutBox <#AboutBox>`_ * `AcceleratorEntry_Create <#AcceleratorEntry_Create>`_ * `App_CleanUp <#App_CleanUp>`_ * `ArtProvider_Delete <#ArtProvider_Delete>`_ * `ArtProvider_GetBitmap <#ArtProvider_GetBitmap>`_ * `ArtProvider_GetIcon <#ArtProvider_GetIcon>`_ * `ArtProvider_GetSizeHint <#ArtProvider_GetSizeHint>`_ * `ArtProvider_Insert <#ArtProvider_Insert>`_ * `ArtProvider_Pop <#ArtProvider_Pop>`_ * `ArtProvider_Push <#ArtProvider_Push>`_ * `AutoBufferedPaintDCFactory <#AutoBufferedPaintDCFactory>`_ B ^ * `BeginBusyCursor <#BeginBusyCursor>`_ * `Bell <#Bell>`_ * `BitmapFromBits <#BitmapFromBits>`_ * `BitmapFromBuffer <#BitmapFromBuffer>`_ * `BitmapFromBufferRGBA <#BitmapFromBufferRGBA>`_ * `BitmapFromIcon <#BitmapFromIcon>`_ * `BitmapFromImage <#BitmapFromImage>`_ * `BitmapFromXPMData <#BitmapFromXPMData>`_ * `BookCtrlBase_GetClassDefaultAttributes <#BookCtrlBase_GetClassDefaultAttributes>`_ * `BrushFromBitmap <#BrushFromBitmap>`_ * `Button_GetClassDefaultAttributes <#Button_GetClassDefaultAttributes>`_ * `Button_GetDefaultSize <#Button_GetDefaultSize>`_ C ^ * `CallAfter <#CallAfter>`_ * `Caret_GetBlinkTime <#Caret_GetBlinkTime>`_ * `Caret_SetBlinkTime <#Caret_SetBlinkTime>`_ * `CheckBox_GetClassDefaultAttributes <#CheckBox_GetClassDefaultAttributes>`_ * `Choice_GetClassDefaultAttributes <#Choice_GetClassDefaultAttributes>`_ * `ClientDisplayRect <#ClientDisplayRect>`_ * `Clipboard_Get <#Clipboard_Get>`_ * `ColorRGB <#ColorRGB>`_ * `ColourDisplay <#ColourDisplay>`_ * `ColourRGB <#ColourRGB>`_ * `ComboBox_GetClassDefaultAttributes <#ComboBox_GetClassDefaultAttributes>`_ * `ConfigBase_Create <#ConfigBase_Create>`_ * `ConfigBase_DontCreateOnDemand <#ConfigBase_DontCreateOnDemand>`_ * `ConfigBase_Get <#ConfigBase_Get>`_ * `ConfigBase_Set <#ConfigBase_Set>`_ * `Control_GetClassDefaultAttributes <#Control_GetClassDefaultAttributes>`_ * `CreateFileTipProvider <#CreateFileTipProvider>`_ * `CursorFromImage <#CursorFromImage>`_ * `CustomDataFormat <#CustomDataFormat>`_ D ^ * `DLG_PNT <#DLG_PNT>`_ * `DLG_SZE <#DLG_SZE>`_ * `DROP_ICON <#DROP_ICON>`_ * `DateSpan_Day <#DateSpan_Day>`_ * `DateSpan_Days <#DateSpan_Days>`_ * `DateSpan_Month <#DateSpan_Month>`_ * `DateSpan_Months <#DateSpan_Months>`_ * `DateSpan_Week <#DateSpan_Week>`_ * `DateSpan_Weeks <#DateSpan_Weeks>`_ * `DateSpan_Year <#DateSpan_Year>`_ * `DateSpan_Years <#DateSpan_Years>`_ * `DateTimeFromDMY <#DateTimeFromDMY>`_ * `DateTimeFromDateTime <#DateTimeFromDateTime>`_ * `DateTimeFromHMS <#DateTimeFromHMS>`_ * `DateTimeFromJDN <#DateTimeFromJDN>`_ * `DateTimeFromTimeT <#DateTimeFromTimeT>`_ * `DateTime_ConvertYearToBC <#DateTime_ConvertYearToBC>`_ * `DateTime_GetAmPmStrings <#DateTime_GetAmPmStrings>`_ * `DateTime_GetBeginDST <#DateTime_GetBeginDST>`_ * `DateTime_GetCentury <#DateTime_GetCentury>`_ * `DateTime_GetCountry <#DateTime_GetCountry>`_ * `DateTime_GetCurrentMonth <#DateTime_GetCurrentMonth>`_ * `DateTime_GetCurrentYear <#DateTime_GetCurrentYear>`_ * `DateTime_GetEndDST <#DateTime_GetEndDST>`_ * `DateTime_GetMonthName <#DateTime_GetMonthName>`_ * `DateTime_GetNumberOfDaysInMonth <#DateTime_GetNumberOfDaysInMonth>`_ * `DateTime_GetNumberOfDaysInYear <#DateTime_GetNumberOfDaysInYear>`_ * `DateTime_GetWeekDayName <#DateTime_GetWeekDayName>`_ * `DateTime_IsDSTApplicable <#DateTime_IsDSTApplicable>`_ * `DateTime_IsLeapYear <#DateTime_IsLeapYear>`_ * `DateTime_IsWestEuropeanCountry <#DateTime_IsWestEuropeanCountry>`_ * `DateTime_Now <#DateTime_Now>`_ * `DateTime_SetCountry <#DateTime_SetCountry>`_ * `DateTime_SetToWeekOfYear <#DateTime_SetToWeekOfYear>`_ * `DateTime_Today <#DateTime_Today>`_ * `DateTime_UNow <#DateTime_UNow>`_ * `Dialog_GetClassDefaultAttributes <#Dialog_GetClassDefaultAttributes>`_ * `DirSelector <#DirSelector>`_ * `DisplayDepth <#DisplayDepth>`_ * `DisplaySize <#DisplaySize>`_ * `DisplaySizeMM <#DisplaySizeMM>`_ * `Display_GetCount <#Display_GetCount>`_ * `Display_GetFromPoint <#Display_GetFromPoint>`_ * `Display_GetFromWindow <#Display_GetFromWindow>`_ * `DragIcon <#DragIcon>`_ * `DragListItem <#DragListItem>`_ * `DragString <#DragString>`_ * `DragTreeItem <#DragTreeItem>`_ * `DrawWindowOnDC <#DrawWindowOnDC>`_ E ^ * `EmptyBitmap <#EmptyBitmap>`_ * `EmptyBitmapRGBA <#EmptyBitmapRGBA>`_ * `EmptyIcon <#EmptyIcon>`_ * `EmptyImage <#EmptyImage>`_ * `EnableTopLevelWindows <#EnableTopLevelWindows>`_ * `EncodingConverter_CanConvert <#EncodingConverter_CanConvert>`_ * `EncodingConverter_GetAllEquivalents <#EncodingConverter_GetAllEquivalents>`_ * `EncodingConverter_GetPlatformEquivalents <#EncodingConverter_GetPlatformEquivalents>`_ * `EndBusyCursor <#EndBusyCursor>`_ * `Execute <#Execute>`_ * `Exit <#Exit>`_ * `ExpandEnvVars <#ExpandEnvVars>`_ F ^ * `FFont <#FFont>`_ * `FFontFromPixelSize <#FFontFromPixelSize>`_ * `FileSelector <#FileSelector>`_ * `FileSystem_AddHandler <#FileSystem_AddHandler>`_ * `FileSystem_CleanUpHandlers <#FileSystem_CleanUpHandlers>`_ * `FileSystem_FileNameToURL <#FileSystem_FileNameToURL>`_ * `FileSystem_RemoveHandler <#FileSystem_RemoveHandler>`_ * `FileSystem_URLToFileName <#FileSystem_URLToFileName>`_ * `FileTypeInfoSequence <#FileTypeInfoSequence>`_ * `FileType_ExpandCommand <#FileType_ExpandCommand>`_ * `FindWindowAtPoint <#FindWindowAtPoint>`_ * `FindWindowAtPointer <#FindWindowAtPointer>`_ * `FindWindowById <#FindWindowById>`_ * `FindWindowByLabel <#FindWindowByLabel>`_ * `FindWindowByName <#FindWindowByName>`_ * `Font2 <#Font2>`_ * `FontEnumerator_GetEncodings <#FontEnumerator_GetEncodings>`_ * `FontEnumerator_GetFacenames <#FontEnumerator_GetFacenames>`_ * `FontEnumerator_IsValidFacename <#FontEnumerator_IsValidFacename>`_ * `FontFromNativeInfo <#FontFromNativeInfo>`_ * `FontFromNativeInfoString <#FontFromNativeInfoString>`_ * `FontFromPixelSize <#FontFromPixelSize>`_ * `FontMapper_Get <#FontMapper_Get>`_ * `FontMapper_GetDefaultConfigPath <#FontMapper_GetDefaultConfigPath>`_ * `FontMapper_GetEncoding <#FontMapper_GetEncoding>`_ * `FontMapper_GetEncodingDescription <#FontMapper_GetEncodingDescription>`_ * `FontMapper_GetEncodingFromName <#FontMapper_GetEncodingFromName>`_ * `FontMapper_GetEncodingName <#FontMapper_GetEncodingName>`_ * `FontMapper_GetSupportedEncodingsCount <#FontMapper_GetSupportedEncodingsCount>`_ * `FontMapper_Set <#FontMapper_Set>`_ * `Font_GetDefaultEncoding <#Font_GetDefaultEncoding>`_ * `Font_SetDefaultEncoding <#Font_SetDefaultEncoding>`_ * `Frame_GetClassDefaultAttributes <#Frame_GetClassDefaultAttributes>`_ G ^ * `GBSizerItemSizer <#GBSizerItemSizer>`_ * `GBSizerItemSpacer <#GBSizerItemSpacer>`_ * `GBSizerItemWindow <#GBSizerItemWindow>`_ * `Gauge_GetClassDefaultAttributes <#Gauge_GetClassDefaultAttributes>`_ * `GenericFindWindowAtPoint <#GenericFindWindowAtPoint>`_ * `GetAccelFromString <#GetAccelFromString>`_ * `GetActiveWindow <#GetActiveWindow>`_ * `GetApp <#GetApp>`_ * `GetBatteryState <#GetBatteryState>`_ * `GetClientDisplayRect <#GetClientDisplayRect>`_ * `GetColourFromUser <#GetColourFromUser>`_ * `GetCurrentId <#GetCurrentId>`_ * `GetCurrentTime <#GetCurrentTime>`_ * `GetDefaultPyEncoding <#GetDefaultPyEncoding>`_ * `GetDisplayDepth <#GetDisplayDepth>`_ * `GetDisplaySize <#GetDisplaySize>`_ * `GetDisplaySizeMM <#GetDisplaySizeMM>`_ * `GetElapsedTime <#GetElapsedTime>`_ * `GetEmailAddress <#GetEmailAddress>`_ * `GetFontFromUser <#GetFontFromUser>`_ * `GetFreeMemory <#GetFreeMemory>`_ * `GetFullHostName <#GetFullHostName>`_ * `GetHomeDir <#GetHomeDir>`_ * `GetHostName <#GetHostName>`_ * `GetKeyState <#GetKeyState>`_ * `GetLocalTime <#GetLocalTime>`_ * `GetLocalTimeMillis <#GetLocalTimeMillis>`_ * `GetLocale <#GetLocale>`_ * `GetMousePosition <#GetMousePosition>`_ * `GetMouseState <#GetMouseState>`_ * `GetNativeFontEncoding <#GetNativeFontEncoding>`_ * `GetNumberFromUser <#GetNumberFromUser>`_ * `GetOsDescription <#GetOsDescription>`_ * `GetOsVersion <#GetOsVersion>`_ * `GetPasswordFromUser <#GetPasswordFromUser>`_ * `GetPowerType <#GetPowerType>`_ * `GetProcessId <#GetProcessId>`_ * `GetSingleChoice <#GetSingleChoice>`_ * `GetSingleChoiceIndex <#GetSingleChoiceIndex>`_ * `GetStockHelpString <#GetStockHelpString>`_ * `GetStockLabel <#GetStockLabel>`_ * `GetTextFromUser <#GetTextFromUser>`_ * `GetTopLevelParent <#GetTopLevelParent>`_ * `GetTopLevelWindows <#GetTopLevelWindows>`_ * `GetTranslation <#GetTranslation>`_ * `GetUTCTime <#GetUTCTime>`_ * `GetUserHome <#GetUserHome>`_ * `GetUserId <#GetUserId>`_ * `GetUserName <#GetUserName>`_ * `GetXDisplay <#GetXDisplay>`_ * `GraphicsContext_Create <#GraphicsContext_Create>`_ * `GraphicsContext_CreateFromNative <#GraphicsContext_CreateFromNative>`_ * `GraphicsContext_CreateFromNativeWindow <#GraphicsContext_CreateFromNativeWindow>`_ * `GraphicsContext_CreateMeasuringContext <#GraphicsContext_CreateMeasuringContext>`_ * `GraphicsRenderer_GetDefaultRenderer <#GraphicsRenderer_GetDefaultRenderer>`_ H ^ * `HelpProvider_Get <#HelpProvider_Get>`_ * `HelpProvider_Set <#HelpProvider_Set>`_ I ^ * `IconBundleFromFile <#IconBundleFromFile>`_ * `IconBundleFromIcon <#IconBundleFromIcon>`_ * `IconFromBitmap <#IconFromBitmap>`_ * `IconFromLocation <#IconFromLocation>`_ * `IconFromXPMData <#IconFromXPMData>`_ * `IdleEvent_CanSend <#IdleEvent_CanSend>`_ * `IdleEvent_GetMode <#IdleEvent_GetMode>`_ * `IdleEvent_SetMode <#IdleEvent_SetMode>`_ * `ImageFromBitmap <#ImageFromBitmap>`_ * `ImageFromBuffer <#ImageFromBuffer>`_ * `ImageFromData <#ImageFromData>`_ * `ImageFromDataWithAlpha <#ImageFromDataWithAlpha>`_ * `ImageFromMime <#ImageFromMime>`_ * `ImageFromStream <#ImageFromStream>`_ * `ImageFromStreamMime <#ImageFromStreamMime>`_ * `ImageHistogram_MakeKey <#ImageHistogram_MakeKey>`_ * `Image_AddHandler <#Image_AddHandler>`_ * `Image_CanRead <#Image_CanRead>`_ * `Image_CanReadStream <#Image_CanReadStream>`_ * `Image_GetHandlers <#Image_GetHandlers>`_ * `Image_GetImageCount <#Image_GetImageCount>`_ * `Image_GetImageExtWildcard <#Image_GetImageExtWildcard>`_ * `Image_HSVtoRGB <#Image_HSVtoRGB>`_ * `Image_InsertHandler <#Image_InsertHandler>`_ * `Image_RGBtoHSV <#Image_RGBtoHSV>`_ * `Image_RemoveHandler <#Image_RemoveHandler>`_ * `InitAllImageHandlers <#InitAllImageHandlers>`_ * `IntersectRect <#IntersectRect>`_ * `IsBusy <#IsBusy>`_ * `IsDragResultOk <#IsDragResultOk>`_ * `IsPlatform64Bit <#IsPlatform64Bit>`_ * `IsPlatformLittleEndian <#IsPlatformLittleEndian>`_ * `IsStockID <#IsStockID>`_ * `IsStockLabel <#IsStockLabel>`_ K ^ * `Kill <#Kill>`_ L ^ * `LaunchDefaultBrowser <#LaunchDefaultBrowser>`_ * `ListBox_GetClassDefaultAttributes <#ListBox_GetClassDefaultAttributes>`_ * `ListCtrl_GetClassDefaultAttributes <#ListCtrl_GetClassDefaultAttributes>`_ * `LoadFileSelector <#LoadFileSelector>`_ * `Locale_AddCatalogLookupPathPrefix <#Locale_AddCatalogLookupPathPrefix>`_ * `Locale_AddLanguage <#Locale_AddLanguage>`_ * `Locale_FindLanguageInfo <#Locale_FindLanguageInfo>`_ * `Locale_GetLanguageInfo <#Locale_GetLanguageInfo>`_ * `Locale_GetLanguageName <#Locale_GetLanguageName>`_ * `Locale_GetSystemEncoding <#Locale_GetSystemEncoding>`_ * `Locale_GetSystemEncodingName <#Locale_GetSystemEncodingName>`_ * `Locale_GetSystemLanguage <#Locale_GetSystemLanguage>`_ * `Locale_IsAvailable <#Locale_IsAvailable>`_ * `LogDebug <#LogDebug>`_ * `LogError <#LogError>`_ * `LogFatalError <#LogFatalError>`_ * `LogGeneric <#LogGeneric>`_ * `LogInfo <#LogInfo>`_ * `LogMessage <#LogMessage>`_ * `LogStatus <#LogStatus>`_ * `LogStatusFrame <#LogStatusFrame>`_ * `LogSysError <#LogSysError>`_ * `LogTrace <#LogTrace>`_ * `LogVerbose <#LogVerbose>`_ * `LogWarning <#LogWarning>`_ * `Log_AddTraceMask <#Log_AddTraceMask>`_ * `Log_ClearTraceMasks <#Log_ClearTraceMasks>`_ * `Log_DontCreateOnDemand <#Log_DontCreateOnDemand>`_ * `Log_EnableLogging <#Log_EnableLogging>`_ * `Log_FlushActive <#Log_FlushActive>`_ * `Log_GetActiveTarget <#Log_GetActiveTarget>`_ * `Log_GetLogLevel <#Log_GetLogLevel>`_ * `Log_GetRepetitionCounting <#Log_GetRepetitionCounting>`_ * `Log_GetTimestamp <#Log_GetTimestamp>`_ * `Log_GetTraceMask <#Log_GetTraceMask>`_ * `Log_GetTraceMasks <#Log_GetTraceMasks>`_ * `Log_GetVerbose <#Log_GetVerbose>`_ * `Log_IsAllowedTraceMask <#Log_IsAllowedTraceMask>`_ * `Log_IsEnabled <#Log_IsEnabled>`_ * `Log_OnLog <#Log_OnLog>`_ * `Log_RemoveTraceMask <#Log_RemoveTraceMask>`_ * `Log_Resume <#Log_Resume>`_ * `Log_SetActiveTarget <#Log_SetActiveTarget>`_ * `Log_SetLogLevel <#Log_SetLogLevel>`_ * `Log_SetRepetitionCounting <#Log_SetRepetitionCounting>`_ * `Log_SetTimestamp <#Log_SetTimestamp>`_ * `Log_SetTraceMask <#Log_SetTraceMask>`_ * `Log_SetVerbose <#Log_SetVerbose>`_ * `Log_Suspend <#Log_Suspend>`_ * `Log_TimeStamp <#Log_TimeStamp>`_ M ^ * `MaskColour <#MaskColour>`_ * `MemoryDCFromDC <#MemoryDCFromDC>`_ * `MemoryFSHandler_AddFile <#MemoryFSHandler_AddFile>`_ * `MemoryFSHandler_AddFileWithMimeType <#MemoryFSHandler_AddFileWithMimeType>`_ * `MemoryFSHandler_RemoveFile <#MemoryFSHandler_RemoveFile>`_ * `MenuBar_GetAutoWindowMenu <#MenuBar_GetAutoWindowMenu>`_ * `MenuBar_MacSetCommonMenuBar <#MenuBar_MacSetCommonMenuBar>`_ * `MenuBar_SetAutoWindowMenu <#MenuBar_SetAutoWindowMenu>`_ * `MenuItem_GetDefaultMarginWidth <#MenuItem_GetDefaultMarginWidth>`_ * `MenuItem_GetLabelFromText <#MenuItem_GetLabelFromText>`_ * `MenuItem_GetLabelText <#MenuItem_GetLabelText>`_ * `MessageBox <#MessageBox>`_ * `MicroSleep <#MicroSleep>`_ * `MilliSleep <#MilliSleep>`_ * `MimeTypesManager_IsOfType <#MimeTypesManager_IsOfType>`_ * `MutexGuiEnter <#MutexGuiEnter>`_ * `MutexGuiLeave <#MutexGuiLeave>`_ N ^ * `NamedColor <#NamedColor>`_ * `NamedColour <#NamedColour>`_ * `NewEventType <#NewEventType>`_ * `NewId <#NewId>`_ * `Notebook_GetClassDefaultAttributes <#Notebook_GetClassDefaultAttributes>`_ * `Now <#Now>`_ * `NullFileTypeInfo <#NullFileTypeInfo>`_ P ^ * `Panel_GetClassDefaultAttributes <#Panel_GetClassDefaultAttributes>`_ * `Point2DCopy <#Point2DCopy>`_ * `Point2DFromPoint <#Point2DFromPoint>`_ * `PostEvent <#PostEvent>`_ * `PostScriptDC_GetResolution <#PostScriptDC_GetResolution>`_ * `PostScriptDC_SetResolution <#PostScriptDC_SetResolution>`_ * `PreBitmapButton <#PreBitmapButton>`_ * `PreButton <#PreButton>`_ * `PreCheckBox <#PreCheckBox>`_ * `PreCheckListBox <#PreCheckListBox>`_ * `PreChoice <#PreChoice>`_ * `PreChoicebook <#PreChoicebook>`_ * `PreCollapsiblePane <#PreCollapsiblePane>`_ * `PreColourPickerCtrl <#PreColourPickerCtrl>`_ * `PreComboBox <#PreComboBox>`_ * `PreControl <#PreControl>`_ * `PreDatePickerCtrl <#PreDatePickerCtrl>`_ * `PreDialog <#PreDialog>`_ * `PreDirFilterListCtrl <#PreDirFilterListCtrl>`_ * `PreDirPickerCtrl <#PreDirPickerCtrl>`_ * `PreFilePickerCtrl <#PreFilePickerCtrl>`_ * `PreFindReplaceDialog <#PreFindReplaceDialog>`_ * `PreFontPickerCtrl <#PreFontPickerCtrl>`_ * `PreFrame <#PreFrame>`_ * `PreGauge <#PreGauge>`_ * `PreGenericDatePickerCtrl <#PreGenericDatePickerCtrl>`_ * `PreGenericDirCtrl <#PreGenericDirCtrl>`_ * `PreHtmlListBox <#PreHtmlListBox>`_ * `PreHyperlinkCtrl <#PreHyperlinkCtrl>`_ * `PreListBox <#PreListBox>`_ * `PreListCtrl <#PreListCtrl>`_ * `PreListView <#PreListView>`_ * `PreListbook <#PreListbook>`_ * `PreMDIChildFrame <#PreMDIChildFrame>`_ * `PreMDIClientWindow <#PreMDIClientWindow>`_ * `PreMDIParentFrame <#PreMDIParentFrame>`_ * `PreMiniFrame <#PreMiniFrame>`_ * `PreNotebook <#PreNotebook>`_ * `PrePanel <#PrePanel>`_ * `PrePopupTransientWindow <#PrePopupTransientWindow>`_ * `PrePopupWindow <#PrePopupWindow>`_ * `PrePyAxBaseWindow <#PrePyAxBaseWindow>`_ * `PrePyControl <#PrePyControl>`_ * `PrePyPanel <#PrePyPanel>`_ * `PrePyScrolledWindow <#PrePyScrolledWindow>`_ * `PrePyWindow <#PrePyWindow>`_ * `PreRadioBox <#PreRadioBox>`_ * `PreRadioButton <#PreRadioButton>`_ * `PreSashLayoutWindow <#PreSashLayoutWindow>`_ * `PreSashWindow <#PreSashWindow>`_ * `PreScrollBar <#PreScrollBar>`_ * `PreScrolledWindow <#PreScrolledWindow>`_ * `PreSearchCtrl <#PreSearchCtrl>`_ * `PreSimpleHtmlListBox <#PreSimpleHtmlListBox>`_ * `PreSingleInstanceChecker <#PreSingleInstanceChecker>`_ * `PreSlider <#PreSlider>`_ * `PreSpinButton <#PreSpinButton>`_ * `PreSpinCtrl <#PreSpinCtrl>`_ * `PreSplitterWindow <#PreSplitterWindow>`_ * `PreStaticBitmap <#PreStaticBitmap>`_ * `PreStaticBox <#PreStaticBox>`_ * `PreStaticLine <#PreStaticLine>`_ * `PreStaticText <#PreStaticText>`_ * `PreStatusBar <#PreStatusBar>`_ * `PreTextCtrl <#PreTextCtrl>`_ * `PreToggleButton <#PreToggleButton>`_ * `PreToolBar <#PreToolBar>`_ * `PreToolbook <#PreToolbook>`_ * `PreTreeCtrl <#PreTreeCtrl>`_ * `PreTreebook <#PreTreebook>`_ * `PreVListBox <#PreVListBox>`_ * `PreVScrolledWindow <#PreVScrolledWindow>`_ * `PreWindow <#PreWindow>`_ * `Printer_GetLastError <#Printer_GetLastError>`_ * `Process_Exists <#Process_Exists>`_ * `Process_Kill <#Process_Kill>`_ * `Process_Open <#Process_Open>`_ * `PyApp_GetComCtl32Version <#PyApp_GetComCtl32Version>`_ * `PyApp_GetMacAboutMenuItemId <#PyApp_GetMacAboutMenuItemId>`_ * `PyApp_GetMacExitMenuItemId <#PyApp_GetMacExitMenuItemId>`_ * `PyApp_GetMacHelpMenuTitleName <#PyApp_GetMacHelpMenuTitleName>`_ * `PyApp_GetMacPreferencesMenuItemId <#PyApp_GetMacPreferencesMenuItemId>`_ * `PyApp_GetMacSupportPCMenuShortcuts <#PyApp_GetMacSupportPCMenuShortcuts>`_ * `PyApp_IsDisplayAvailable <#PyApp_IsDisplayAvailable>`_ * `PyApp_IsMainLoopRunning <#PyApp_IsMainLoopRunning>`_ * `PyApp_SetMacAboutMenuItemId <#PyApp_SetMacAboutMenuItemId>`_ * `PyApp_SetMacExitMenuItemId <#PyApp_SetMacExitMenuItemId>`_ * `PyApp_SetMacHelpMenuTitleName <#PyApp_SetMacHelpMenuTitleName>`_ * `PyApp_SetMacPreferencesMenuItemId <#PyApp_SetMacPreferencesMenuItemId>`_ * `PyApp_SetMacSupportPCMenuShortcuts <#PyApp_SetMacSupportPCMenuShortcuts>`_ * `PyAxBaseWindow_FromHWND <#PyAxBaseWindow_FromHWND>`_ Q ^ * `Quantize_Quantize <#Quantize_Quantize>`_ R ^ * `RadioBox_GetClassDefaultAttributes <#RadioBox_GetClassDefaultAttributes>`_ * `RadioButton_GetClassDefaultAttributes <#RadioButton_GetClassDefaultAttributes>`_ * `RectPP <#RectPP>`_ * `RectPS <#RectPS>`_ * `RectS <#RectS>`_ * `RegionFromBitmap <#RegionFromBitmap>`_ * `RegionFromBitmapColour <#RegionFromBitmapColour>`_ * `RegionFromPoints <#RegionFromPoints>`_ * `RegisterId <#RegisterId>`_ * `RendererNative_Get <#RendererNative_Get>`_ * `RendererNative_GetDefault <#RendererNative_GetDefault>`_ * `RendererNative_GetGeneric <#RendererNative_GetGeneric>`_ * `RendererNative_Set <#RendererNative_Set>`_ * `RendererVersion_IsCompatible <#RendererVersion_IsCompatible>`_ * `Renderer_DrawChoice <#Renderer_DrawChoice>`_ * `Renderer_DrawComboBox <#Renderer_DrawComboBox>`_ * `Renderer_DrawRadioButton <#Renderer_DrawRadioButton>`_ * `Renderer_DrawTextCtrl <#Renderer_DrawTextCtrl>`_ S ^ * `SafeShowMessage <#SafeShowMessage>`_ * `SafeYield <#SafeYield>`_ * `SaveFileSelector <#SaveFileSelector>`_ * `ScrollBar_GetClassDefaultAttributes <#ScrollBar_GetClassDefaultAttributes>`_ * `ScrolledWindow_GetClassDefaultAttributes <#ScrolledWindow_GetClassDefaultAttributes>`_ * `SetCursor <#SetCursor>`_ * `SetDefaultPyEncoding <#SetDefaultPyEncoding>`_ * `Shell <#Shell>`_ * `ShowTip <#ShowTip>`_ * `Shutdown <#Shutdown>`_ * `SizerFlags_GetDefaultBorder <#SizerFlags_GetDefaultBorder>`_ * `SizerItemSizer <#SizerItemSizer>`_ * `SizerItemSpacer <#SizerItemSpacer>`_ * `SizerItemWindow <#SizerItemWindow>`_ * `Sleep <#Sleep>`_ * `Slider_GetClassDefaultAttributes <#Slider_GetClassDefaultAttributes>`_ * `SoundFromData <#SoundFromData>`_ * `Sound_PlaySound <#Sound_PlaySound>`_ * `Sound_Stop <#Sound_Stop>`_ * `SpinButton_GetClassDefaultAttributes <#SpinButton_GetClassDefaultAttributes>`_ * `SpinCtrl_GetClassDefaultAttributes <#SpinCtrl_GetClassDefaultAttributes>`_ * `SplitterWindow_GetClassDefaultAttributes <#SplitterWindow_GetClassDefaultAttributes>`_ * `StandardPaths_Get <#StandardPaths_Get>`_ * `StartTimer <#StartTimer>`_ * `StaticBitmap_GetClassDefaultAttributes <#StaticBitmap_GetClassDefaultAttributes>`_ * `StaticBox_GetClassDefaultAttributes <#StaticBox_GetClassDefaultAttributes>`_ * `StaticLine_GetClassDefaultAttributes <#StaticLine_GetClassDefaultAttributes>`_ * `StaticLine_GetDefaultSize <#StaticLine_GetDefaultSize>`_ * `StaticText_GetClassDefaultAttributes <#StaticText_GetClassDefaultAttributes>`_ * `StatusBar_GetClassDefaultAttributes <#StatusBar_GetClassDefaultAttributes>`_ * `StockCursor <#StockCursor>`_ * `StockGDI_DeleteAll <#StockGDI_DeleteAll>`_ * `StockGDI_GetBrush <#StockGDI_GetBrush>`_ * `StockGDI_GetColour <#StockGDI_GetColour>`_ * `StockGDI_GetCursor <#StockGDI_GetCursor>`_ * `StockGDI_GetPen <#StockGDI_GetPen>`_ * `StockGDI_instance <#StockGDI_instance>`_ * `StripMenuCodes <#StripMenuCodes>`_ * `SysErrorCode <#SysErrorCode>`_ * `SysErrorMsg <#SysErrorMsg>`_ * `SystemOptions_GetOption <#SystemOptions_GetOption>`_ * `SystemOptions_GetOptionInt <#SystemOptions_GetOptionInt>`_ * `SystemOptions_HasOption <#SystemOptions_HasOption>`_ * `SystemOptions_IsFalse <#SystemOptions_IsFalse>`_ * `SystemOptions_SetOption <#SystemOptions_SetOption>`_ * `SystemOptions_SetOptionInt <#SystemOptions_SetOptionInt>`_ * `SystemSettings_GetColour <#SystemSettings_GetColour>`_ * `SystemSettings_GetFont <#SystemSettings_GetFont>`_ * `SystemSettings_GetMetric <#SystemSettings_GetMetric>`_ * `SystemSettings_GetScreenType <#SystemSettings_GetScreenType>`_ * `SystemSettings_HasFeature <#SystemSettings_HasFeature>`_ * `SystemSettings_SetScreenType <#SystemSettings_SetScreenType>`_ T ^ * `TestFontEncoding <#TestFontEncoding>`_ * `TextAttr_Combine <#TextAttr_Combine>`_ * `TextAttr_Merge <#TextAttr_Merge>`_ * `TextCtrl_GetClassDefaultAttributes <#TextCtrl_GetClassDefaultAttributes>`_ * `Thread_IsMain <#Thread_IsMain>`_ * `TimeSpan_Day <#TimeSpan_Day>`_ * `TimeSpan_Days <#TimeSpan_Days>`_ * `TimeSpan_Hour <#TimeSpan_Hour>`_ * `TimeSpan_Hours <#TimeSpan_Hours>`_ * `TimeSpan_Millisecond <#TimeSpan_Millisecond>`_ * `TimeSpan_Milliseconds <#TimeSpan_Milliseconds>`_ * `TimeSpan_Minute <#TimeSpan_Minute>`_ * `TimeSpan_Minutes <#TimeSpan_Minutes>`_ * `TimeSpan_Second <#TimeSpan_Second>`_ * `TimeSpan_Seconds <#TimeSpan_Seconds>`_ * `TimeSpan_Week <#TimeSpan_Week>`_ * `TimeSpan_Weeks <#TimeSpan_Weeks>`_ * `ToggleButton_GetClassDefaultAttributes <#ToggleButton_GetClassDefaultAttributes>`_ * `ToolBar_GetClassDefaultAttributes <#ToolBar_GetClassDefaultAttributes>`_ * `ToolTip_Enable <#ToolTip_Enable>`_ * `ToolTip_SetDelay <#ToolTip_SetDelay>`_ * `Trap <#Trap>`_ * `TreeCtrl_GetClassDefaultAttributes <#TreeCtrl_GetClassDefaultAttributes>`_ U ^ * `UpdateUIEvent_CanUpdate <#UpdateUIEvent_CanUpdate>`_ * `UpdateUIEvent_GetMode <#UpdateUIEvent_GetMode>`_ * `UpdateUIEvent_GetUpdateInterval <#UpdateUIEvent_GetUpdateInterval>`_ * `UpdateUIEvent_ResetUpdateTime <#UpdateUIEvent_ResetUpdateTime>`_ * `UpdateUIEvent_SetMode <#UpdateUIEvent_SetMode>`_ * `UpdateUIEvent_SetUpdateInterval <#UpdateUIEvent_SetUpdateInterval>`_ * `Usleep <#Usleep>`_ V ^ * `Validator_IsSilent <#Validator_IsSilent>`_ * `Validator_SetBellOnError <#Validator_SetBellOnError>`_ * `version <#version>`_ W ^ * `WakeUpIdle <#WakeUpIdle>`_ * `WakeUpMainThread <#WakeUpMainThread>`_ * `Window_FindFocus <#Window_FindFocus>`_ * `Window_FromHWND <#Window_FromHWND>`_ * `Window_GetCapture <#Window_GetCapture>`_ * `Window_GetClassDefaultAttributes <#Window_GetClassDefaultAttributes>`_ * `Window_NewControlId <#Window_NewControlId>`_ * `Window_NextControlId <#Window_NextControlId>`_ * `Window_PrevControlId <#Window_PrevControlId>`_ Y ^ * `Yield <#Yield>`_ * `YieldIfNeeded <#YieldIfNeeded>`_ Functions ========= .. function:: AboutBox(info) This function shows the standard about dialog containing the information specified in `info`. If the current platform has a native about dialog which is capable of showing all the fields in `wx.AboutDialogInfo `_, the native dialog is used, otherwise the function falls back to the generic wxWidgets version of the dialog. Here is an example of how this function may be used:: def ShowSimpleAboutDialog(event): info = wx.AboutDialogInfo() info.SetName("My Program") info.SetVersion("1.2.3 Beta") info.SetDescription("This program does something great.") info.SetCopyright("(C) 2007 Me ") wx.AboutBox(info) | **Parameters:** * `info` (`wx.AboutDialogInfo `_) -------- .. function:: AcceleratorEntry_Create(str) Create accelerator corresponding to the specified string, or ``None`` if it coulnd't be parsed. **Parameters:** * `str` (string) | **Returns:** `wx.AcceleratorEntry `_ -------- .. function:: App_CleanUp() For internal use only, it is used to cleanup after wxWidgets when Python shuts down. -------- .. function:: ArtProvider_Delete(provider) Remove provider. The provider must have been added previously! The provider is **not** deleted. **Parameters:** * `provider` (`wx.ArtProvider `_) | **Returns:** `bool` -------- .. function:: ArtProvider_GetBitmap(id, client=wx.ART_OTHER, size=wx.DefaultSize) Query the providers for bitmap with given ID and return it. Returns `wx.NullBitmap` if no provider provides it. **Parameters:** * `id` (string) * `client` (string) * `size` (`wx.Size `_) | **Returns:** `wx.Bitmap `_ -------- .. function:: ArtProvider_GetIcon(id, client=wx.ART_OTHER, size=wx.DefaultSize) Query the providers for icon with given ID and return it. Returns `wx.NullIcon` if no provider provides it. **Parameters:** * `id` (string) * `client` (string) * `size` (`wx.Size `_) | **Returns:** `wx.Icon `_ -------- .. function:: ArtProvider_GetSizeHint(client, platform_dependent=False) Get the size hint of an icon from a specific Art Client, queries the topmost provider if `platform_dependent` is ``False``. **Parameters:** * `client` (string) * `platform_dependent` (bool) | **Returns:** `wx.Size `_ -------- .. function:: ArtProvider_Insert(provider) Add new provider to the bottom of providers stack. **Parameters:** * `provider` (`wx.ArtProvider `_) -------- .. function:: ArtProvider_Pop() Remove latest added provider and delete it. | **Returns:** `bool` -------- .. function:: ArtProvider_Push(provider) Add new provider to the top of providers stack. **Parameters:** * `provider` (`wx.ArtProvider `_) -------- .. function:: AutoBufferedPaintDCFactory(window) Checks if the window is natively double buffered and will return a `wx.PaintDC `_ if it is, a `wx.BufferedPaintDC `_ otherwise. The advantage of this function over `wx.AutoBufferedPaintDC `_ is that this function will check if the the specified window has double-buffering enabled rather than just going by platform defaults. **Parameters:** * `window` (`wx.Window `_) | **Returns:** `wx.DC `_ -------- .. function:: BeginBusyCursor(cursor=wx.HOURGLASS_CURSOR) Changes the cursor to the given cursor for all windows in the application. Use `wx.EndBusyCursor <#EndBusyCursor>`_ to revert the cursor back to its previous state. These two calls can be nested, and a counter ensures that only the outer calls take effect. **Parameters:** * `cursor` (`wx.Cursor `_) .. seealso:: `IsBusy <#IsBusy>`_, `BusyCursor <#BusyCursor>`_ -------- .. function:: Bell() Rings the system bell. -------- .. function:: BitmapFromBits(bits, width, height, depth=1) Creates a bitmap from an array of bits. You should only use this function for monochrome bitmaps (depth 1) in portable programs: in this case the bits parameter should contain an XBM image. For other bit depths, the behaviour is platform dependent. **Parameters:** * `bits` (PyObject) * `width` (int) * `height` (int) * `depth` (int) | **Returns:** `wx.Bitmap `_ -------- .. function:: BitmapFromBuffer(width, height, dataBuffer, alphaBuffer=None) Creates a `wx.Bitmap `_ from the data in `dataBuffer`. The `dataBuffer` parameter must be a Python object that implements the buffer interface, such as a string, array, etc. The `dataBuffer` object is expected to contain a series of RGB bytes and be width\*height\*3 bytes long. A buffer object can optionally be supplied for the image's alpha channel data, and it is expected to be width\*height bytes long. On Windows and Mac the RGB values are 'premultiplied' by the alpha values. (The other platforms do the multiplication themselves.) Unlike `wx.ImageFromBuffer <#ImageFromBuffer>`_ the bitmap created with this function does not share the memory buffer with the buffer object. This is because the native pixel buffer format varies on different platforms, and so instead an efficient as possible copy of the data is made from the buffer objects to the bitmap's native pixel buffer. For direct access to a bitmap's pixel buffer see `wx.NativePixelData `_ and `wx.AlphaPixelData `_. **Parameters:** * `width` (int) * `height` (int) * `dataBuffer` (PyObject) * `alphaBuffer` (PyObject) .. seealso:: `wx.Bitmap `_, `wx.BitmapFromBufferRGBA <#BitmapFromBufferRGBA>`_, `wx.NativePixelData `_, `wx.AlphaPixelData `_, `wx.ImageFromBuffer <#ImageFromBuffer>`_ -------- .. function:: BitmapFromBufferRGBA(width, height, dataBuffer) Creates a `wx.Bitmap `_ from the data in `dataBuffer`. The dataBuffer parameter must be a Python object that implements the buffer interface, such as a string, array, etc. The `dataBuffer` object is expected to contain a series of RGB bytes and be width\*height\*3 bytes long. A buffer object can optionally be supplied for the image's alpha channel data, and it is expected to be width\*height bytes long. On Windows and Mac the RGB values are 'premultiplied' by the alpha values. (The other platforms do the multiplication themselves.) Unlike `wx.ImageFromBuffer <#ImageFromBuffer>`_ the bitmap created with this function does not share the memory buffer with the buffer object. This is because the native pixel buffer format varies on different platforms, and so instead an efficient as possible copy of the data is made from the buffer objects to the bitmap's native pixel buffer. For direct access to a bitmap's pixel buffer see `wx.NativePixelData `_ and `wx.AlphaPixelData `_. **Parameters:** * `width` (int) * `height` (int) * `dataBuffer` (PyObject) .. seealso:: `wx.Bitmap `_, `wx.BitmapFromBuffer <#BitmapFromBufferRGBA>`_, `wx.NativePixelData `_, `wx.AlphaPixelData `_, `wx.ImageFromBuffer <#ImageFromBuffer>`_ -------- .. function:: BitmapFromIcon(icon) Create a new bitmap from a `wx.Icon `_ object. **Parameters:** * `icon` (`wx.Icon `_) | **Returns:** `wx.Bitmap `_ -------- .. function:: BitmapFromImage(image, depth=-1) Creates bitmap object from a `wx.Image `_. This has to be done to actually display a `wx.Image `_ as you cannot draw an image directly on a window. The resulting bitmap will use the provided colour depth (or that of the current screen colour depth if `depth` is -1) which entails that a colour reduction may have to take place. **Parameters:** * `image` (`wx.Image `_) * `depth` (int) | **Returns:** `wx.Bitmap `_ -------- .. function:: BitmapFromXPMData(listOfStrings) Construct a Bitmap from a list of strings formatted as XPM data. **Parameters:** * `listOfStrings` (list of strings) | **Returns:** `wx.Bitmap `_ -------- .. function:: BookCtrlBase_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: BrushFromBitmap(stippleBitmap) Constructs a stippled brush using a bitmap. **Parameters:** * `stippleBitmap` (`wx.Bitmap `_) | **Returns:** `wx.Brush `_ -------- .. function:: Button_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: Button_GetDefaultSize() Returns the default button size for this platform. | **Returns:** `wx.Size `_ -------- .. function:: CallAfter(callable) Call the specified function after the current and pending event handlers have been completed. This is also good for making GUI method calls from non-GUI threads. Any extra positional or keyword args are passed on to the callable when it is called. **Parameters:** * `callable` (PyObject) .. seealso:: `wx.CallLater `_ -------- .. function:: Caret_GetBlinkTime() See `wx.Caret.GetBlinkTime `_ | **Returns:** `int` -------- .. function:: Caret_SetBlinkTime(milliseconds) See `wx.Caret.SetBlinkTime `_ **Parameters:** * `milliseconds` (int) -------- .. function:: CheckBox_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: Choice_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: ClientDisplayRect() Returns the dimensions of the work area on the display. On Windows this means the area not covered by the taskbar, etc... Other platforms are currently defaulting to the whole display until a way is found to provide this info for all window managers, etc. | **Returns:** `(x, y, width, height)` -------- .. function:: Clipboard_Get() Returns global instance (`wx.TheClipboard`) of the object. | **Returns:** `wx.Clipboard `_ -------- .. function:: ColorRGB() Constructs a colour from a packed RGB value. | **Returns:** `wx.Colour `_ -------- .. function:: ColourDisplay() Returns ``True`` if the display is colour, ``False`` otherwise. | **Returns:** `bool` -------- .. function:: ColourRGB() Constructs a colour from a packed RGB value. | **Returns:** `wx.Colour `_ -------- .. function:: ComboBox_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: ConfigBase_Create() Create and return a new global config object. This function will create the "best" implementation of `wx.Config` available for the current platform. | **Returns:** `wx.ConfigBase `_ -------- .. function:: ConfigBase_DontCreateOnDemand() Should Get() try to create a new log object if there isn't a current one? -------- .. function:: ConfigBase_Get(createOnDemand=True) Returns the current global config object, creating one if neccessary. **Parameters:** * `createOnDemand` (bool) | **Returns:** `wx.ConfigBase `_ -------- .. function:: ConfigBase_Set(config) Sets the global config object (the one returned by `Get`) and returns a reference to the previous global config object. **Parameters:** * `config` (`wx.ConfigBase `_) | **Returns:** `wx.ConfigBase `_ -------- .. function:: Control_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: CreateFileTipProvider(filename, currentTip) This function creates a `wx.TipProvider `_ which may be used with `wx.ShowTip <#ShowTip>`_. **Parameters:** * `filename` (string): The name of the file containing the tips, one per line. * `currentTip` (int): The index of the first tip to show -- normally the index is remembered between the 2 program runs. | **Returns:** `wx.TipProvider `_ -------- .. function:: CursorFromImage(image) Constructs a cursor from a `wx.Image `_. The mask (if any) will be used for setting the transparent portions of the cursor. **Parameters:** * `image` (`wx.Image `_) | **Returns:** `wx.Cursor `_ -------- .. function:: CustomDataFormat(format) Constructs a data format object for a custom format identified by its name. **Parameters:** * `format` (string) | **Returns:** `wx.DataFormat `_ -------- .. function:: DLG_PNT(win, point_or_x, y=None) Convenience function for converting a `wx.Point `_ or (x, y) in dialog units to pixel units. **Parameters:** * `win` (`wx.Window `_) * `point_or_x` * `y` (int) -------- .. function:: DLG_SZE(win, size_width, height=None) Convenience function for converting a `wx.Size `_ or (w, h) in dialog units to pixel units. **Parameters:** * `win` (`wx.Window `_) * `size_width` * `height` (int) -------- .. function:: DROP_ICON(filename) Returns either a `wx.Cursor `_ or `wx.Icon `_ created from the image file `filename`. This function is useful with the `wx.DropSource `_ class which, depending on platform accepts either a icon or a cursor. **Parameters:** * `filename` (string) -------- .. function:: DateSpan_Day() See `wx.DateSpan.Day `_ | **Returns:** `wx.DateSpan `_ -------- .. function:: DateSpan_Days(days) See `wx.DateSpan.Days `_ **Parameters:** * `days` (int) | **Returns:** `wx.DateSpan `_ -------- .. function:: DateSpan_Month() See `wx.DateSpan.Month `_ | **Returns:** `wx.DateSpan `_ -------- .. function:: DateSpan_Months(mon) See `wx.DateSpan.Months `_ **Parameters:** * `mon` (int) | **Returns:** `wx.DateSpan `_ -------- .. function:: DateSpan_Week() See `wx.DateSpan.Week `_ | **Returns:** `wx.DateSpan `_ -------- .. function:: DateSpan_Weeks(weeks) See `wx.DateSpan.Weeks `_ **Parameters:** * `weeks` (int) | **Returns:** `wx.DateSpan `_ -------- .. function:: DateSpan_Year() See `wx.DateSpan.Year `_ | **Returns:** `wx.DateSpan `_ -------- .. function:: DateSpan_Years(years) See `wx.DateSpan.Years `_ **Parameters:** * `years` (int) | **Returns:** `wx.DateSpan `_ -------- .. function:: DateTimeFromDMY(day, month=wx.DateTime.Inv_Month, year=wx.DateTime.Inv_Year, hour=0, minute=0, second=0, millisec=0) Creates a `wx.DateTime` object from a day-month-year triplet plus optional hour, minute, second and millisecond parameters. **Parameters:** * `day` (int) * `month` (int) * `year` (int) * `hour` (int) * `minute` (int) * `second` (int) * `millisec` (int) | **Returns:** `wx.DateTime `_ -------- .. function:: DateTimeFromDateTime(date) Creates a `wx.DateTime` object from a `wx.DateTime` object. **Parameters:** * `date` (`wx.DateTime `_) | **Returns:** `wx.DateTime `_ -------- .. function:: DateTimeFromHMS(hour, minute=0, second=0, millisec=0) Creates a `wx.DateTime` object from a hour-minute-second-millisecond quadruplet. **Parameters:** * `hour` (int) * `minute` (int) * `second` (int) * `millisec` (int) | **Returns:** `wx.DateTime `_ -------- .. function:: DateTimeFromJDN(jdn) Creates a `wx.DateTime` object from Julian Day Number. **Parameters:** * `jdn` (double) | **Returns:** `wx.DateTime `_ -------- .. function:: DateTimeFromTimeT(timet) | **Parameters:** * `timet` (time_t) | **Returns:** `wx.DateTime `_ -------- .. function:: DateTime_ConvertYearToBC(year) See `wx.DateTime.ConvertYearToBC `_. **Parameters:** * `year` (int) | **Returns:** `int` -------- .. function:: DateTime_GetAmPmStrings() Get the AM and PM strings in the current locale (may be empty) | **Returns:** `(am, pm)` -------- .. function:: DateTime_GetBeginDST(year=wx.DateTime.Inv_Year, country=wx.DateTime.Country_Default) See `wx.DateTime.GetBeginDST `_. **Parameters:** * `year` (int) * `country` (int) | **Returns:** `wx.DateTime `_ -------- .. function:: DateTime_GetCentury(year=wx.DateTime.Inv_Year) See `wx.DateTime.GetCentury `_. **Parameters:** * `year` (int) | **Returns:** `int` -------- .. function:: DateTime_GetCountry() See `wx.DateTime.GetCountry `_. | **Returns:** `int` -------- .. function:: DateTime_GetCurrentMonth(cal=wx.DateTime.Gregorian) See `wx.DateTime.GetCurrentMonth `_. **Parameters:** * `cal` (int) | **Returns:** `int` -------- .. function:: DateTime_GetCurrentYear(cal=Gregorian) See `wx.DateTime.GetCurrentYear `_. **Parameters:** * `cal` (int) | **Returns:** `int` -------- .. function:: DateTime_GetEndDST(year=wx.DateTime.Inv_Year, country=wx.DateTime.Country_Default) See `wx.DateTime.GetEndDST `_. **Parameters:** * `year` (int) * `country` (int) | **Returns:** `wx.DateTime `_ -------- .. function:: DateTime_GetMonthName(month, flags=wx.DateTime.Name_Full) See `wx.DateTime.GetMonthName `_. **Parameters:** * `month` (int) * `flags` (int) | **Returns:** `String` -------- .. function:: DateTime_GetNumberOfDaysInMonth(month, year=wx.DateTime.Inv_Year, cal=wx.DateTime.Gregorian) See `wx.DateTime.GetNumberOfDaysInMonth `_. **Parameters:** * `month` (int) * `year` (int) * `cal` (int) | **Returns:** `int` -------- .. function:: DateTime_GetNumberOfDaysInYear(year, cal=wx.DateTime.Gregorian) See `wx.DateTime.GetNumberOfDaysInYear `_. **Parameters:** * `year` (int) * `cal` (int) | **Returns:** `int` -------- .. function:: DateTime_GetWeekDayName(weekday, flags=wx.DateTime.Name_Full) See `wx.DateTime.GetWeekDayName `_. **Parameters:** * `weekday` (int) * `flags` (int) | **Returns:** `String` -------- .. function:: DateTime_IsDSTApplicable(year=wx.DateTime.Inv_Year, country=wx.DateTime.Country_Default) See `wx.DateTime.IsDSTApplicable `_. **Parameters:** * `year` (int) * `country` (int) | **Returns:** `bool` -------- .. function:: DateTime_IsLeapYear(year=wx.DateTime.Inv_Year, cal=wx.DateTime.Gregorian) See `wx.DateTime.IsLeapYear `_. **Parameters:** * `year` (int) * `cal` (int) | **Returns:** `bool` -------- .. function:: DateTime_IsWestEuropeanCountry(country=wx.DateTime.Country_Default) See `wx.DateTime.IsWestEuropeanCountry `_. **Parameters:** * `country` (int) | **Returns:** `bool` -------- .. function:: DateTime_Now() See `wx.DateTime.Now `_. | **Returns:** `wx.DateTime `_ -------- .. function:: DateTime_SetCountry(country) See `wx.DateTime.SetCountry `_. **Parameters:** * `country` (int) -------- .. function:: DateTime_SetToWeekOfYear(year, numWeek, weekday=wx.DateTime.Mon) See `wx.DateTime.SetToWeekOfYear `_. **Parameters:** * `year` (int) * `numWeek` (int) * `weekday` (int) | **Returns:** `wx.DateTime `_ -------- .. function:: DateTime_Today() See `wx.DateTime.Today `_. | **Returns:** `wx.DateTime `_ -------- .. function:: DateTime_UNow() See `wx.DateTime.UNow `_. | **Returns:** `wx.DateTime `_ -------- .. function:: Dialog_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: DirSelector(message=wx.DirSelectorPromptStr, defaultPath="", style=wx.DD_DEFAULT_STYLE, pos=wx.DefaultPosition, parent=None) Pops up a directory selector dialog. The arguments have the same meaning as those of `wx.DirDialog.__init__ `_. The message is displayed at the top, and the `defaultPath`, if specified, is set as the initial selection. The application must check for an empty return value (if the user pressed ``Cancel``). For example:: directory = wx.DirSelector("Choose a folder") if not directory.strip(): # User cancelled the dialog... DoSomething() | **Parameters:** * `message` (string) * `defaultPath` (string) * `style` (long) * `pos` (`wx.Point `_) * `parent` (`wx.Window `_) | **Returns:** `string` -------- .. function:: DisplayDepth() Returns the depth of the display (a value of 1 denotes a monochrome display). | **Returns:** `int` -------- .. function:: DisplaySize() Returns the display size in pixels. | **Returns:** `(width, height)` -------- .. function:: DisplaySizeMM() Returns the display size in millimeters. | **Returns:** `(width, height)` -------- .. function:: Display_GetCount() Return the number of available displays. | **Returns:** `int` -------- .. function:: Display_GetFromPoint(pt) Find the display where the given point lies, return ``wx.NOT_FOUND`` if it doesn't belong to any display **Parameters:** * `pt` (`wx.Point `_) | **Returns:** `int` -------- .. function:: Display_GetFromWindow(window) Find the display where the given window lies, return ``wx.NOT_FOUND`` if it is not shown at all. **Parameters:** * `window` (`wx.Window `_) | **Returns:** `int` -------- .. function:: DragIcon(image, cursor=wx.NullCursor) Constructs a drag image from an icon and optional cursor. **Parameters:** * `image` (`wx.Icon `_) * `cursor` (`wx.Cursor `_) | **Returns:** `wx.DragImage `_ -------- .. function:: DragListItem(listCtrl, id) Constructs a drag image from the text in the given list control item, and optional cursor. **Parameters:** * `listCtrl` (`wx.ListCtrl `_) * `id` (long) | **Returns:** `wx.DragImage `_ -------- .. function:: DragString(str, cursor=wx.NullCursor) Constructs a drag image from a text string and optional cursor. **Parameters:** * `str` (string) * `cursor` (`wx.Cursor `_) | **Returns:** `wx.DragImage `_ -------- .. function:: DragTreeItem(treeCtrl, id) Constructs a drag image from the text in the given tree control item, and optional cursor. **Parameters:** * `treeCtrl` (`wx.TreeCtrl `_) * `id` (`wx.TreeItemId `_) | **Returns:** `wx.DragImage `_ -------- .. function:: DrawWindowOnDC(window, dc) | **Parameters:** * `window` (`wx.Window `_) * `dc` (`wx.DC `_) | **Returns:** `bool` -------- .. function:: EmptyBitmap(width, height, depth=-1) Creates a new bitmap of the given size. A depth of -1 indicates the depth of the current screen or visual. Some platforms only support 1 for monochrome and -1 for the current display depth. **Parameters:** * `width` (int) * `height` (int) * `depth` (int) | **Returns:** `wx.Bitmap `_ -------- .. function:: EmptyBitmapRGBA(width, height, red=0, green=0, blue=0, alpha=0) Returns a new empty 32-bit bitmap where every pixel has been initialized with the given RGBA values. **Parameters:** * `width` (int) * `height` (int) * `red` (int) * `green` (int) * `blue` (int) * `alpha` (int) | **Returns:** `wx.Bitmap `_ -------- .. function:: EmptyIcon() | **Returns:** `wx.Icon `_ -------- .. function:: EmptyImage(width=0, height=0, clear=True) Construct an empty image of a given size, optionally setting all pixels to black. **Parameters:** * `width` (int) * `height` (int) * `clear` (bool) | **Returns:** `wx.Image `_ -------- .. function:: EnableTopLevelWindows(enable) This function enables or disables all top level windows. It is used by `wx.SafeYield <#SafeYield>`_. **Parameters:** * `enable` (bool) -------- .. function:: EncodingConverter_CanConvert(encIn, encOut) See `wx.EncodingConverter.CanConvert `_. **Parameters:** * `encIn` (int) * `encOut` (int) | **Returns:** `bool` -------- .. function:: EncodingConverter_GetAllEquivalents(enc) See `wx.EncodingConverter.GetAllEquivalents `_. **Parameters:** * `enc` (int) | **Returns:** `list of strings` -------- .. function:: EncodingConverter_GetPlatformEquivalents(enc, platform=wx.PLATFORM_CURRENT) See `wx.EncodingConverter.GetPlatformEquivalents `_. **Parameters:** * `enc` (int) * `platform` (int) | **Returns:** `list of strings` -------- .. function:: EndBusyCursor() Changes the cursor back to the original cursor, for all windows in the application. Use with `wx.BeginBusyCursor <#BeginBusyCursor>`_. .. seealso:: `IsBusy <#IsBusy>`_, `BusyCursor <#BusyCursor>`_ -------- .. function:: Execute(command, flags=wx.EXEC_ASYNC, process=None) Launches the specified process. If `flags` parameter contains ``wx.EXEC_ASYNC`` flag (the default), flow of control immediately returns. If it contains ``wx.EXEC_SYNC``, the current application waits until the other program has terminated. In the case of synchronous execution, the return value is the exit code of the process (which terminates by the moment the function returns) and will be -1 if the process couldn't be started and typically 0 if the process terminated successfully. Also, while waiting for the process to terminate, `wx.Execute` will call `wx.Yield <#Yield>`_. Because of this, by default this function disables all application windows to avoid unexpected reentrancies which could result from the users interaction with the program while the child process is running. If you are sure that it is safe to not disable the program windows, you may pass ``wx.EXEC_NODISABLE`` flag to prevent this automatic disabling from happening. For asynchronous execution, however, the return value is the process id and zero value indicates that the command could not be executed. As an added complication, the return value of -1 in this case indicates that we didn't launch a new process, but connected to the running one (this can only happen in case of using DDE under Windows for command execution). In particular, in this, and only this, case the calling code will not get the notification about process termination. Under Unix the flag ``wx.EXEC_MAKE_GROUP_LEADER`` may be used to ensure that the new process is a group leader (this will create a new session if needed). Calling `wx.Kill <#Kill>`_ passing ``wx.KILL_CHILDREN`` will kill this process as well as all of its children (except those which have started their own session). **Parameters:** * `command` (string) * `flags` (int) * `process` (`wx.Process `_) | **Returns:** `int` .. note:: Currently `wx.Execute` can only be used from the main thread, calling this function from another thread will result in an assert failure in debug build and won't work. -------- .. function:: Exit() Force an exit of the application. Exits application after calling `wx.App.OnExit`. Should only be used in an emergency: normally the top-level frame should be deleted (after deleting all other frames) to terminate the application. See `wx.CloseEvent `_. -------- .. function:: ExpandEnvVars(sz) Replace environment variables (``$SOMETHING``) with their values. The format is ``$VARNAME`` or ``${VARNAME}`` where `VARNAME` contains alphanumeric characters and '_' only. '$' must be escaped ('\$') in order to be taken literally. **Parameters:** * `sz` (string) | **Returns:** `string` -------- .. function:: FFont(pointSize, family, flags=wx.FONTFLAG_DEFAULT, face="", encoding=wx.FONTENCODING_DEFAULT) A bit of a simpler way to create a `wx.Font `_ using flags instead of individual attribute settings. The value of flags can be a combination of the following: =============================== == Font Flag =============================== == ``wx.FONTFLAG_DEFAULT`` ``wx.FONTFLAG_ITALIC`` ``wx.FONTFLAG_SLANT`` ``wx.FONTFLAG_LIGHT`` ``wx.FONTFLAG_BOLD`` ``wx.FONTFLAG_ANTIALIASED`` ``wx.FONTFLAG_NOT_ANTIALIASED`` ``wx.FONTFLAG_UNDERLINED`` ``wx.FONTFLAG_STRIKETHROUGH`` =============================== == | **Parameters:** * `pointSize` (int) * `family` (int) * `flags` (int) * `face` (string) * `encoding` (int) | **Returns:** `wx.Font `_ .. seealso:: `wx.Font `_ -------- .. function:: FFontFromPixelSize(pixelSize, family, flags=wx.FONTFLAG_DEFAULT, face="", encoding=wx.FONTENCODING_DEFAULT) Creates a font using a size in pixels rather than points. If there is platform API support for this then it is used, otherwise a font with the closest size is found using a binary search. **Parameters:** * `pixelSize` (`wx.Size `_) * `family` (int) * `flags` (int) * `face` (string) * `encoding` (int) | **Returns:** `wx.Font `_ .. seealso:: `wx.Font `_ -------- .. function:: FileSelector(message=wx.FileSelectorPromptStr, default_path="", default_filename="", default_extension="", wildcard=wx.FileSelectorDefaultWildcardStr, flags=0, parent=None, x=-1, y=-1) Pops up a file selector box. In Windows, this is the common file selector dialog. In X, this is a file selector box with the same functionality. The path and filename are distinct elements of a full file pathname. If `default_path` is empty, the current directory will be used. If `default_filename` is empty, no default filename will be supplied. The `wildcard` determines what files are displayed in the file selector, and file extension supplies a type extension for the required filename. `flags` may be a combination of ``wx.FD_OPEN``, ``wx.FD_SAVE``, ``wx.FD_OVERWRITE_PROMPT`` or ``wx.FD_FILE_MUST_EXIST``. Both the Unix and Windows versions implement a wildcard filter. Typing a filename containing wildcards (\*, ?) in the filename text item, and clicking on ``Ok``, will result in only those files matching the pattern being displayed. The `wildcard` may be a specification for multiple types of file with a description for each, such as:: "BMP files (*.bmp)|*.bmp | GIF files (*.gif)|*.gif" The application must check for an empty return value (the user pressed ``Cancel``). For example:: filename = wx.FileSelector("Choose a file to open") if filename.strip(): # work with the file UserSelectedFile(filename) else: # cancelled by user Cancelled() | **Parameters:** * `message` (string) * `default_path` (string) * `default_filename` (string) * `default_extension` (string) * `wildcard` (string) * `flags` (int) * `parent` (`wx.Window `_) * `x` (int) * `y` (int) | **Returns:** `string` .. note:: Note that ``wx.FD_MULTIPLE`` can only be used with `wx.FileDialog `_ and not here as this function only returns a single file name. -------- .. function:: FileSystem_AddHandler(handler) See `wx.FileSystem.AddHandler `_. **Parameters:** * `handler` (`wx.FileSystemHandler `_) -------- .. function:: FileSystem_CleanUpHandlers() See `wx.FileSystem.CleanUpHandlers `_. -------- .. function:: FileSystem_FileNameToURL(filename) See `wx.FileSystem.FileNameToURL `_. **Parameters:** * `filename` (string) | **Returns:** `string` -------- .. function:: FileSystem_RemoveHandler(handler) See `wx.FileSystem.RemoveHandler `_. **Parameters:** * `handler` (`wx.FileSystemHandler `_) | **Returns:** `wx.FileSystemHandler `_ -------- .. function:: FileSystem_URLToFileName(url) See `wx.FileSystem.URLToFileName `_. **Parameters:** * `url` (string) | **Returns:** `string` -------- .. function:: FileTypeInfoSequence(sArray) | **Parameters:** * `sArray` (list of strings) | **Returns:** `wx.FileTypeInfo` -------- .. function:: FileType_ExpandCommand(command, filename, mimetype="") See `wx.FileType.ExpandCommand `_. **Parameters:** * `command` (string) * `filename` (string) * `mimetype` (string) | **Returns:** `string` -------- .. function:: FindWindowAtPoint(pt) Returns the window currently at point `pt`. Otherwise it returns ``None``. **Parameters:** * `pt` (`wx.Point `_) | **Returns:** `wx.Window `_ -------- .. function:: FindWindowAtPointer() Returns the window currently under the mouse pointer, if it belongs to this application. Otherwise it returns ``None``. | **Returns:** `wx.Window `_ -------- .. function:: FindWindowById(id, parent=None) Find the first window in the application with the given `id`. If `parent` is ``None``, the search will start from all top-level frames and dialog boxes; if non-``None``, the search will be limited to the given window hierarchy. The search is recursive in both cases. **Parameters:** * `id` (long) * `parent` (`wx.Window `_) | **Returns:** `wx.Window `_ -------- .. function:: FindWindowByLabel(label, parent=None) Find a window by its label. Depending on the type of window, the label may be a window title or panel item label. If `parent` is ``None``, the search will start from all top-level frames and dialog boxes; if non-``None``, the search will be limited to the given window hierarchy. The search is recursive in both cases. **Parameters:** * `label` (string) * `parent` (`wx.Window `_) | **Returns:** `wx.Window `_ -------- .. function:: FindWindowByName(name, parent=None) Find a window by its name (as given in a window constructor or `Create` function call). If `parent` is ``None``, the search will start from all top-level frames and dialog boxes; if non-``None``, the search will be limited to the given window hierarchy. The search is recursive in both cases. If no window with such name is found, `wx.FindWindowByLabel <#FindWindowByLabel>`_ is called. **Parameters:** * `name` (string) * `parent` (`wx.Window `_) | **Returns:** `wx.Window `_ -------- .. function:: Font2() Use `wx.FFont `_ instead. -------- .. function:: FontEnumerator_GetEncodings() See `wx.FontEnumerator.GetEncodings `_. | **Returns:** `PyObject` -------- .. function:: FontEnumerator_GetFacenames() See `wx.FontEnumerator.GetFacenames `_. | **Returns:** `PyObject` -------- .. function:: FontEnumerator_IsValidFacename(str) Convenience function that returns ``True`` if the given face name exist in the user's system. **Parameters:** * `str` (string) | **Returns:** `bool` -------- .. function:: FontFromNativeInfo(info) Construct a `wx.Font `_ from a `wx.NativeFontInfo `_ object. **Parameters:** * `info` (`wx.NativeFontInfo `_) | **Returns:** `wx.Font `_ -------- .. function:: FontFromNativeInfoString(info) Construct a `wx.Font `_ from the string representation of a `wx.NativeFontInfo `_ object. **Parameters:** * `info` (string) | **Returns:** `wx.Font `_ -------- .. function:: FontFromPixelSize(pixelSize, family, style, weight, underlined=False, face="", encoding=wx.FONTENCODING_DEFAULT) Creates a font using a size in pixels rather than points. If there is platform API support for this then it is used, otherwise a font with the closest size is found using a binary search. **Parameters:** * `pixelSize` (`wx.Size `_) * `family` (int) * `style` (int) * `weight` (int) * `underlined` (bool) * `face` (string) * `encoding` (int) | **Returns:** `wx.Font `_ .. seealso:: `wx.Font `_ -------- .. function:: FontMapper_Get() See `wx.FontMapper `_. | **Returns:** `wx.FontMapper `_ -------- .. function:: FontMapper_GetDefaultConfigPath() See `wx.FontMapper.GetDefaultConfigPath `_. | **Returns:** `string` -------- .. function:: FontMapper_GetEncoding(n) See `wx.FontMapper.GetEncoding `_. **Parameters:** * `n` (int) | **Returns:** `int` -------- .. function:: FontMapper_GetEncodingDescription(encoding) See `wx.FontMapper.GetEncodingDescription `_. **Parameters:** * `encoding` (int) | **Returns:** `string` -------- .. function:: FontMapper_GetEncodingFromName(name) See `wx.FontMapper.GetEncodingFromName `_. **Parameters:** * `name` (string) | **Returns:** `int` -------- .. function:: FontMapper_GetEncodingName(encoding) See `wx.FontMapper.GetEncodingName `_. **Parameters:** * `encoding` (int) | **Returns:** `string` -------- .. function:: FontMapper_GetSupportedEncodingsCount() See `wx.FontMapper.GetSupportedEncodingsCount `_. | **Returns:** `int` -------- .. function:: FontMapper_Set(mapper) See `wx.FontMapper.Set `_. **Parameters:** * `mapper` (`wx.FontMapper `_) | **Returns:** `wx.FontMapper `_ -------- .. function:: Font_GetDefaultEncoding() Returns the encoding used for all fonts created with an encoding of ``wx.FONTENCODING_DEFAULT``. | **Returns:** `int` -------- .. function:: Font_SetDefaultEncoding(encoding) Sets the default font encoding. **Parameters:** * `encoding` (int) -------- .. function:: Frame_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: GBSizerItemSizer(sizer, pos, span, flag, border, userData=None) Construct a `wx.GBSizerItem `_ for a sizer **Parameters:** * `sizer` (`wx.Sizer `_) * `pos` (`wx.GBPosition `_) * `span` (`wx.GBSpan `_) * `flag` (int) * `border` (int) * `userData` (PyObject) | **Returns:** `wx.GBSizerItem `_ -------- .. function:: GBSizerItemSpacer(width, height, pos, span, flag, border, userData=None) Construct a `wx.GBSizerItem `_ for a spacer. **Parameters:** * `width` (int) * `height` (int) * `pos` (`wx.GBPosition `_) * `span` (`wx.GBSpan `_) * `flag` (int) * `border` (int) * `userData` (PyObject) | **Returns:** `wx.GBSizerItem `_ -------- .. function:: GBSizerItemWindow(window, pos, span, flag, border, userData=None) Construct a `wx.GBSizerItem `_ for a window. **Parameters:** * `window` (`wx.Window `_) * `pos` (`wx.GBPosition `_) * `span` (`wx.GBSpan `_) * `flag` (int) * `border` (int) * `userData` (PyObject) | **Returns:** `wx.GBSizerItem `_ -------- .. function:: Gauge_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: GenericFindWindowAtPoint(pt) | **Parameters:** * `pt` (`wx.Point `_) | **Returns:** `wx.Window `_ -------- .. function:: GetAccelFromString(label) Returns the accelerator string in a label. **Parameters:** * `label` (string) | **Returns:** `wx.AcceleratorEntry `_ -------- .. function:: GetActiveWindow() Get the currently active window of this application, or ``None``. Implemented in MSW and GTK+ only, returns ``None`` in other ports. | **Returns:** `wx.Window `_ -------- .. function:: GetApp() Returns a reference to the current `wx.App` object. | **Returns:** `wx.PyApp `_ -------- .. function:: GetBatteryState() Returns battery state as one of ``wx.BATTERY_NORMAL_STATE``, ``wx.BATTERY_LOW_STATE``, ``wx.BATTERY_CRITICAL_STATE``, ``wx.BATTERY_SHUTDOWN_STATE`` or ``wx.BATTERY_UNKNOWN_STATE``. ``wx.BATTERY_UNKNOWN_STATE`` is also the default on platforms where this feature is not implemented (currently everywhere but MS Windows). | **Returns:** `int` -------- .. function:: GetClientDisplayRect() Returns the dimensions of the work area on the display. On Windows this means the area not covered by the taskbar, etc. Other platforms are currently defaulting to the whole display until a way is found to provide this info for all window managers, etc... | **Returns:** `wx.Rect `_ -------- .. function:: GetColourFromUser(parent=None, colInit=wx.NullColour, caption="") Shows the colour selection dialog and returns the colour selected by user or invalid colour (use `wx.Colour.IsOk `_ to test whether a colour is valid) if the dialog was cancelled. **Parameters:** * `parent` (`wx.Window `_): The parent window for the colour selection dialog. * `colInit` (`wx.Colour `_): If given, this will be the colour initially selected in the dialog. * `caption` (string): If given, this will be used for the dialog caption. | **Returns:** `wx.Colour `_ -------- .. function:: GetCurrentId() | **Returns:** `int` -------- .. function:: GetCurrentTime() | **Returns:** `int` -------- .. function:: GetDefaultPyEncoding() Gets the current encoding that wxPython will use when it needs to convert a Python string or unicode object to or from a wxString. | **Returns:** `string` -------- .. function:: GetDisplayDepth() Returns the depth of the display (a value of 1 denotes a monochrome display). | **Returns:** `int` -------- .. function:: GetDisplaySize() Returns the display size in pixels. | **Returns:** `wx.Size `_ -------- .. function:: GetDisplaySizeMM() Returns the display size in millimeters. | **Returns:** `wx.Size `_ -------- .. function:: GetElapsedTime(resetTimer=True) Gets the time in milliseconds since the last `wx.StartTimer <#StartTimer>`_. If `resetTimer` is true (the default), the timer is reset to zero by this call. .. warning:: This function is deprecated. -------- .. function:: GetEmailAddress() Returns the user's email address, by concatenating the values returned by `wx.GetFullHostName <#GetFullHostName>`_ and `wx.GetUserId <#GetUserId>`_. | **Returns:** `string` -------- .. function:: GetFontFromUser(parent=None, fontInit=wx.NullFont, caption="") Shows the font selection dialog and returns the font selected by user or invalid font (use `wx.Font.IsOk `_ to test whether a font is valid) if the dialog was cancelled. **Parameters:** * `parent` (`wx.Window `_): The parent window for the font selection dialog * `fontInit` (`wx.Font `_): If given, this will be the font initially selected in the dialog. * `caption` (string): If given, this will be used for the dialog caption | **Returns:** `wx.Font `_ -------- .. function:: GetFreeMemory() Returns the amount of free memory in bytes under environments which support it, and -1 if not supported or failed to perform measurement. | **Returns:** `int` -------- .. function:: GetFullHostName() Returns the FQDN (fully qualified domain host name) or an empty string on error. | **Returns:** `string` .. seealso:: `GetHostName <#GetHostName>`_ -------- .. function:: GetHomeDir() Returns the curent user's home directory. | **Returns:** `string` .. seealso:: `GetUserHome <#GetUserHome>`_, `wx.StandardPaths `_ -------- .. function:: GetHostName() Returns the hostname if successful or an empty string otherwise. Please note that the returned name is not fully qualified, i.e. it does not include the domain name. Under Windows or NT, this function first looks in the environment variable `SYSTEM_NAME`; if this is not found, the entry `HostName` in the wxWidgets section of the WIN.INI file is tried. | **Returns:** `string` -------- .. function:: GetKeyState(key) Get the state of a key (``True`` if pressed or toggled on, ``False`` if not). This is generally most useful getting the state of the modifier or toggle keys. On some platforms those may be the only keys that this function is able to detect. **Parameters:** * `key` (int) | **Returns:** `bool` -------- .. function:: GetLocalTime() Returns the number of seconds since local time 00:00:00 Jan 1st 1970. | **Returns:** `int` .. seealso:: `wx.DateTime.Now `_ -------- .. function:: GetLocalTimeMillis() Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970. | **Returns:** `int` .. seealso:: `wx.DateTime.Now `_ -------- .. function:: GetLocale() Returns the current locale. | **Returns:** `wx.Locale `_ -------- .. function:: GetMousePosition() Get the current mouse position on the screen. | **Returns:** `wx.Point `_ -------- .. function:: GetMouseState() Returns the current state of the mouse. Returns an instance of a `wx.MouseState` object that contains the current position of the mouse pointer in screen coordinants, as well as boolean values indicating the up/down status of the mouse buttons and the modifier keys. | **Returns:** `wx.MouseState` -------- .. function:: GetNativeFontEncoding(encoding) | **Parameters:** * `encoding` (int) | **Returns:** `wx.NativeEncodingInfo` -------- .. function:: GetNumberFromUser(message, prompt, caption, value, min=0, max=100, parent=None, pos=wx.DefaultPosition) Shows a dialog asking the user for numeric input. The dialogs title is set to `caption`, it contains a (possibly) multiline message above the single line `prompt` and the zone for entering the number. The number entered must be in the range `min` ... `max` (both of which should be positive) and `value` is the initial value of it. If the user enters an invalid value or cancels the dialog, the function will return -1. The dialog is centered on its parent unless an explicit position is given in `pos`. **Parameters:** * `message` (string) * `prompt` (string) * `caption` (string) * `value` (long) * `min` (long) * `max` (long) * `parent` (`wx.Window `_) * `pos` (`wx.Point `_) | **Returns:** `int` -------- .. function:: GetOsDescription() Returns the string containing the description of the current platform in a user-readable form. For example, this function may return strings like ``Windows NT Version 4.0`` or ``Linux 2.2.2 i386``. | **Returns:** `string` -------- .. function:: GetOsVersion() Gets the version and the operating system ID for currently running OS. | **Returns:** `(platform, major, minor)` -------- .. function:: GetPasswordFromUser(message, caption="", default_value="", parent=None) Similar to `wx.GetTextFromUser <#GetTextFromUser>`_ but the text entered in the dialog is not shown on screen but replaced with stars. This is intended to be used for entering passwords as the function name implies. **Parameters:** * `message` (string) * `caption` (string) * `default_value` (string) * `parent` (`wx.Window `_) | **Returns:** `string` -------- .. function:: GetPowerType() Returns the current system power state: online or offline. | **Returns:** `int` -------- .. function:: GetProcessId() Returns the number uniquely identifying the current process in the system. If an error occurs, 0 is returned. | **Returns:** `int` -------- .. function:: GetSingleChoice(message, caption, choices, parent=None, x=-1, y=-1, centre=True, width=150, height=200) Pops up a dialog box containing a message, ``OK`` / ``Cancel`` buttons and a single-selection listbox. The user may choose an item and press ``OK`` to return a string or ``Cancel`` to return the empty string. Use `wx.GetSingleChoiceIndex <#GetSingleChoiceIndex>`_ if empty string is a valid choice and if you want to be able to detect pressing ``Cancel`` reliably. You may pass the list of strings to choose from using `choices` which is an array of n strings for the listbox. If `centre` is ``True``, the message text (which may include new line characters) is centred; if ``False``, the message is left-justified. **Parameters:** * `message` (string) * `caption` (string) * `choices` (int) * `parent` (`wx.Window `_) * `x` (int) * `y` (int) * `centre` (bool) * `width` (int) * `height` (int) | **Returns:** `string` -------- .. function:: GetSingleChoiceIndex(message, caption, choices, parent=None, x=-1, y=-1, centre=True, width=150, height=200) As `wx.GetSingleChoice <#GetSingleChoice>`_ but returns the index representing the selected string. If the user pressed ``Cancel``, -1 is returned. **Parameters:** * `message` (string) * `caption` (string) * `choices` (int) * `parent` (`wx.Window `_) * `x` (int) * `y` (int) * `centre` (bool) * `width` (int) * `height` (int) | **Returns:** `int` -------- .. function:: GetStockHelpString(id, client=wx.STOCK_MENU) | **Parameters:** * `id` (int) * `client` (int) | **Returns:** `string` -------- .. function:: GetStockLabel(id, flags=wx.STOCK_WITH_MNEMONIC) Returns label that should be used for given `id` element. **Parameters:** * `id` (int): given id of the `wx.MenuItem `_, `wx.Button `_, `wx.ToolBar `_ tool etc... * `flags` (long): Whether to include mnemonics or not. | **Returns:** `string` -------- .. function:: GetTextFromUser(message, caption="", default_value="", parent=None, x=-1, y=-1, centre=True) Pop up a dialog box with title set to `caption`, `message`, and a `default_value`. The user may type in text and press ``OK`` to return this text, or press ``Cancel`` to return the empty string. If `centre` is ``True``, the message text (which may include new line characters) is centred; if ``False``, the message is left-justified. **Parameters:** * `message` (string) * `caption` (string) * `default_value` (string) * `parent` (`wx.Window `_) * `x` (int) * `y` (int) * `centre` (bool) | **Returns:** `string` -------- .. function:: GetTopLevelParent(win) Returns the first top level parent of the given window, or in other words, the frame or dialog containing it, or ``None``. **Parameters:** * `win` (`wx.Window `_) | **Returns:** `wx.Window `_ -------- .. function:: GetTopLevelWindows() Returns a list-like object of the the application's top-level windows, (frames, dialogs, etc...). | **Returns:** `wx.WindowList` -------- .. function:: GetTranslation(str) Alternative signatures: `GetTranslation(String str, String domain)` `GetTranslation(String str, String strPlural, int n)` `GetTranslation(String str, String strPlural, int n, String domain)` This function returns the translation of string `str` in the current locale. If the string is not found in any of the loaded message catalogs, the original string is returned. In debug build, an error message is logged -- this should help to find the strings which were not yet translated. If `domain` is specified then only that domain/catalog is searched for a matching string. The third form is used when retrieving translation of string that has different singular and plural form in English or different plural forms in some other language. It takes two extra arguments: as above, `str` parameter must contain the singular form of the string to be converted and is used as the key for the search in the catalog. The `strPlural` parameter is the plural form (in English). The parameter `n` is used to determine the plural form. If no message catalog is found str is returned if `n` == 1, otherwise `strPlural`. All versions call `wx.Locale.GetString `_. **Parameters:** * `str` (string) | **Returns:** `string` .. note:: Note that this function is not suitable for literal strings in Unicode builds. -------- .. function:: GetUTCTime() Returns the number of seconds since GMT 00:00:00 Jan 1st 1970. | **Returns:** `int` -------- .. function:: GetUserHome(user="") Returns the home directory for the given user. If the `user` is empty (default value), this function behaves like `wx.GetHomeDir <#GetHomeDir>`_. **Parameters:** * `user` (string) | **Returns:** `string` -------- .. function:: GetUserId() This function returns the "user id" also known as "login name" under Unix i.e. something like "jsmith". It uniquely identifies the current user (on this system). Under Windows or NT, this function first looks in the environment variables `USER` and `LOGNAME`; if neither of these is found, the entry `UserId` in the wxWidgets section of the WIN.INI file is tried. This function returns the login name if successful or an empty string otherwise. | **Returns:** `string` -------- .. function:: GetUserName() This function returns the full user name (something like "Mr. John Smith"). Under Windows or NT, this function looks for the entry `UserName` in the wxWidgets section of the WIN.INI file. If PenWindows is running, the entry Current in the section User of the PENWIN.INI file is used. This function returns the user name if successful or an empty string otherwise. | **Returns:** `string` -------- .. function:: GetXDisplay() Returns a swigified pointer to the X11 display. Returns ``None`` on other platforms. | **Returns:** `void` -------- .. function:: GraphicsContext_Create(dc) Alternative signature: `GraphicsContext_Create(wx.Window window)` Creates a `wx.GraphicsContext `_ either from a window or a DC. **Parameters:** * `dc` (`wx.DC `_) | **Returns:** `wx.GraphicsContext `_ -------- .. function:: GraphicsContext_CreateFromNative(context) Creates a `wx.GraphicsContext `_ from a native context. This native context must be eg a CGContextRef for Core Graphics, a Graphics pointer for GDIPlus or a cairo_t pointer for Cairo. **Parameters:** * `context` (void) | **Returns:** `wx.GraphicsContext `_ .. note:: For wxPython we still need a way to make this value usable. -------- .. function:: GraphicsContext_CreateFromNativeWindow(window) Creates a wx.GraphicsContext from a native window. **Parameters:** * `window` (void) | **Returns:** `wx.GraphicsContext `_ .. note:: For wxPython we still need a way to make this value usable. -------- .. function:: GraphicsContext_CreateMeasuringContext() Create a lightwieght context that can be used for measuring text only. | **Returns:** `wx.GraphicsContext `_ -------- .. function:: GraphicsRenderer_GetDefaultRenderer() Returns the default renderer on this platform. On OS X this is the Core Graphics (a.k.a. Quartz 2D) renderer, on MSW the GDIPlus renderer, and on GTK we currently default to the cairo renderer. | **Returns:** `wx.GraphicsRenderer `_ -------- .. function:: HelpProvider_Get() Return the current application-wide help provider. | **Returns:** `wx.HelpProvider `_ -------- .. function:: HelpProvider_Set(helpProvider) Sset the current, application-wide help provider. Returns the previous one. Unlike some other classes, the help provider is not created on demand. This must be explicitly done by the application. **Parameters:** * `helpProvider` (`wx.HelpProvider `_) | **Returns:** `wx.HelpProvider `_ -------- .. function:: IconBundleFromFile(file, type) Initializes the bundle with the icon(s) found in the file. **Parameters:** * `file` (string) * `type` (long) | **Returns:** `wx.IconBundle `_ -------- .. function:: IconBundleFromIcon(icon) Initializes the bundle with a single icon. **Parameters:** * `icon` (`wx.Icon `_) | **Returns:** `wx.IconBundle `_ -------- .. function:: IconFromBitmap(bmp) Creates an icon starting from a bitmap. **Parameters:** * `bmp` (`wx.Bitmap `_) | **Returns:** `wx.Icon `_ -------- .. function:: IconFromLocation(loc) Creates an icon starting from a specified location. **Parameters:** * `loc` (`wx.IconLocation `_) | **Returns:** `wx.Icon `_ -------- .. function:: IconFromXPMData(listOfStrings) Creates an icon starting from a list of strings containing XPM data. **Parameters:** * `listOfStrings` (list of strings) | **Returns:** `wx.Icon `_ -------- .. function:: IdleEvent_CanSend(win) Returns ``True`` if it is appropriate to send idle events to this window. This function looks at the mode used (see `wx.IdleEvent.SetMode `_), and the ``wx.WS_EX_PROCESS_IDLE`` style in window to determine whether idle events should be sent to this window now. By default this will always return ``True`` because the update mode is initially ``wx.IDLE_PROCESS_ALL``. You can change the mode to only send idle events to windows with the ``wx.WS_EX_PROCESS_IDLE`` extra window style set. **Parameters:** * `win` (`wx.Window `_) | **Returns:** `bool` -------- .. function:: IdleEvent_GetMode() Static method returning a value specifying how wxWidgets will send idle events: to all windows, or only to those which specify that they will process the events. | **Returns:** `int` -------- .. function:: IdleEvent_SetMode(mode) Static method for specifying how wxWidgets will send idle events: to all windows, or only to those which specify that they will process the events. The mode can be one of the following values: ============================== ======================================== Mode Flag Description ============================== ======================================== ``wx.IDLE_PROCESS_ALL`` Send idle events to all windows. ``wx.IDLE_PROCESS_SPECIFIED`` Send idle events only to windows that have the ``wx.WS_EX_PROCESS_IDLE`` extra style flag set. ============================== ======================================== | **Parameters:** * `mode` (int) -------- .. function:: ImageFromBitmap(bitmap) Construct a `wx.Image` from a `wx.Bitmap `_. **Parameters:** * `bitmap` (`wx.Bitmap `_) | **Returns:** `wx.Image `_ -------- .. function:: ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None) Creates a `wx.Image `_ from the data in `dataBuffer`. The `dataBuffer` parameter must be a Python object that implements the buffer interface, such as a string, array, etc... The `dataBuffer` object is expected to contain a series of RGB bytes and be width\*height\*3 bytes long. A buffer object can optionally be supplied for the image's alpha channel data, and it is expected to be width\*height bytes long. The `wx.Image` will be created with its data and alpha pointers initialized to the memory address pointed to by the buffer objects, thus saving the time needed to copy the image data from the buffer object to the `wx.Image`. While this has advantages, it also has the shoot-yourself-in-the-foot risks associated with sharing a C pointer between two objects. To help alleviate the risk a reference to the data and alpha buffer objects are kept with the `wx.Image`, so that they won't get deleted until after the `wx.Image` is deleted. However please be aware that it is not guaranteed that an object won't move its memory buffer to a new location when it needs to resize its contents. If that happens then the `wx.Image` will end up referring to an invalid memory location and could cause the application to crash. Therefore care should be taken to not manipulate the objects used for the data and alpha buffers in a way that would cause them to change size. **Parameters:** * `width` (int) * `height` (int) * `dataBuffer` (PyObject) * `alphaBuffer` (PyObject) -------- .. function:: ImageFromData(width, height, data) Construct an Image from a buffer of RGB bytes. Accepts either a string or a buffer object holding the data and the length of the data must be width\*height\*3. **Parameters:** * `width` (int) * `height` (int) * `data` (buffer) | **Returns:** `wx.Image `_ -------- .. function:: ImageFromDataWithAlpha(width, height, data, alpha) Construct an Image from a buffer of RGB bytes with an Alpha channel. Accepts either a string or a buffer object holding the data and the length of the data must be width\*height\*3 bytes, and the length of the alpha data must be width*height bytes. **Parameters:** * `width` (int) * `height` (int) * `data` (buffer) * `alpha` (buffer) | **Returns:** `wx.Image `_ -------- .. function:: ImageFromMime(name, mimetype, index=-1) Loads an image from a file, using a MIME type string (such as 'image/jpeg') to specify image type. **Parameters:** * `name` (string) * `mimetype` (string) * `index` (int) | **Returns:** `wx.Image `_ -------- .. function:: ImageFromStream(stream, type=wx.BITMAP_TYPE_ANY, index=-1) Loads an image from an input stream, or any readable Python file-like object. **Parameters:** * `stream` (`wx.InputStream `_) * `type` (long) * `index` (int) | **Returns:** `wx.Image `_ -------- .. function:: ImageFromStreamMime(stream, mimetype, index=-1) Loads an image from an input stream, or any readable Python file-like object, specifying the image format with a MIME type string. **Parameters:** * `stream` (`wx.InputStream `_) * `mimetype` (string) * `index` (int) | **Returns:** `wx.Image `_ -------- .. function:: ImageHistogram_MakeKey(r, g, b) Get the key in the histogram for the given RGB values **Parameters:** * `r` (byte) * `g` (byte) * `b` (byte) | **Returns:** `int` -------- .. function:: Image_AddHandler(handler) Adds a handler to the end of the static list of format handlers. **Parameters:** * `handler` (`wx.ImageHandler `_): A new image format handler object. There is usually only one instance of a given handler class in an application session. -------- .. function:: Image_CanRead(filename) Returns ``True`` if the image handlers can read this file. **Parameters:** * `filename` (string) | **Returns:** `bool` -------- .. function:: Image_CanReadStream(stream) Returns ``True`` if the image handlers can read an image file from the data currently on the input stream, or a readable Python file-like object. **Parameters:** * `stream` (`wx.InputStream `_) | **Returns:** `bool` -------- .. function:: Image_GetHandlers() Returns the static list of image format handlers. | **Returns:** `PyObject` -------- .. function:: Image_GetImageCount(filename, type=wx.BITMAP_TYPE_ANY) If the image file contains more than one image and the image handler is capable of retrieving these individually, this function will return the number of available images. **Parameters:** * `filename` (string) * `type` (long) | **Returns:** `int` -------- .. function:: Image_GetImageExtWildcard() Iterates all registered `wx.ImageHandler `_ objects, and returns a string containing file extension masks suitable for passing to file open/save dialog boxes. | **Returns:** `string` -------- .. function:: Image_HSVtoRGB(hsv) Converts a color in HSV color space to RGB color space. **Parameters:** * `hsv` (`wx.Image_HSVValue `_) | **Returns:** `wx.Image_RGBValue `_ -------- .. function:: Image_InsertHandler(handler) Adds a handler at the start of the static list of format handlers. **Parameters:** * `handler` (`wx.ImageHandler `_) -------- .. function:: Image_RGBtoHSV(rgb) Converts a color in RGB color space to HSV color space. **Parameters:** * `rgb` (`wx.Image_RGBValue `_) | **Returns:** `wx.Image_HSVValue `_ -------- .. function:: Image_RemoveHandler(name) Finds the handler with the given name, and removes it. The handler is not deleted. **Parameters:** * `name` (string) | **Returns:** `bool` -------- .. function:: InitAllImageHandlers() The former functionality of `InitAllImageHanders` is now done internal to the ``_core_`` extension module and so this function has become a simple NOP. -------- .. function:: IntersectRect(r1, r2) Calculate and return the intersection of `r1` and `r2`. **Parameters:** * `r1` (`wx.Rect `_) * `r2` (`wx.Rect `_) | **Returns:** `wx.Rect `_ -------- .. function:: IsBusy() Returns ``True`` if between two `wx.BeginBusyCursor <#BeginBusyCursor>`_ and `wx.EndBusyCursor <#EndBusyCursor>`_ calls. | **Returns:** `bool` .. seealso:: `wx.BeginBusyCursor <#BeginBusyCursor>`_, `wx.EndBusyCursor <#EndBusyCursor>`_ -------- .. function:: IsDragResultOk(res) | **Parameters:** * `res` (int) | **Returns:** `bool` -------- .. function:: IsPlatform64Bit() Returns ``True`` if the operating system the program is running under is 64 bit. The check is performed at run-time and may differ from the value available at compile-time (at compile-time you can just check if sizeof(void*)==8) since the program could be running in emulation mode or in a mixed 32/64 bit system (bi-architecture operating system). | **Returns:** `bool` .. important:: this function is not 100% reliable on some systems given the fact that there isn't always a standard way to do a reliable check on the OS architecture. -------- .. function:: IsPlatformLittleEndian() Returns ``True`` if the current platform is little endian (instead of big endian). The check is performed at run-time. | **Returns:** `bool` -------- .. function:: IsStockID(id) | **Parameters:** * `id` (int) | **Returns:** `bool` -------- .. function:: IsStockLabel(id, label) | **Parameters:** * `id` (int) * `label` (string) | **Returns:** `bool` -------- .. function:: Kill(pid, sig=wx.SIGTERM, rc, flags=wx.KILL_NOCHILDREN) Equivalent to the Unix `kill` function: send the given signal `sig` to the process with PID `pid`. The valid signal values are: * ``wx.SIGNONE`` = 0 ---> verify if the process exists under Unix * ``wx.SIGHUP`` * ``wx.SIGINT`` * ``wx.SIGQUIT`` * ``wx.SIGILL`` * ``wx.SIGTRAP`` * ``wx.SIGABRT`` * ``wx.SIGEMT`` * ``wx.SIGFPE`` * ``wx.SIGKILL`` ---> forcefully kill, dangerous! * ``wx.SIGBUS`` * ``wx.SIGSEGV`` * ``wx.SIGSYS`` * ``wx.SIGPIPE`` * ``wx.SIGALRM`` * ``wx.SIGTERM`` ---> terminate the process gently ``wx.SIGNONE``, ``wx.SIGKILL`` and ``wx.SIGTERM`` have the same meaning under both Unix and Windows but all the other signals are equivalent to ``wx.SIGTERM`` under Windows. Returns one of the following flags: ========================= ====================== Kill Error Flags Description ========================= ====================== ``wx.KILL_OK`` no error ``wx.KILL_BAD_SIGNAL`` no such signal ``wx.KILL_ACCESS_DENIED`` permission denied ``wx.KILL_NO_PROCESS`` no such process ``wx.KILL_ERROR`` another, unspecified error ========================= ====================== The `flags` parameter can be ``wx.KILL_NOCHILDREN`` (the default), or ``wx.KILL_CHILDREN``, in which case the child processes of this process will be killed too. Note that under Unix, for ``wx.KILL_CHILDREN`` to work you should have created the process passing ``wx.EXEC_MAKE_GROUP_LEADER``. | **Parameters:** * `pid` (long) * `sig` (int) * `rc` (int) * `flags` (int) | **Returns:** `int` -------- .. function:: LaunchDefaultBrowser(url) Launches the user's default browser and tells it to open the location at `url`. Returns ``True`` if the application was successfully launched. **Parameters:** * `url` (string) | **Returns:** `bool` .. note:: Note that for some configurations of the running user, the application which is launched to open the given URL may be URL-dependent (e.g. a browser may be used for local URLs while another one may be used for remote URLs). -------- .. function:: ListBox_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: ListCtrl_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: LoadFileSelector(what, extension, default_name="", parent=None) | **Parameters:** * `what` (string) * `extension` (string) * `default_name` (string) * `parent` (`wx.Window `_) | **Returns:** `string` -------- .. function:: Locale_AddCatalogLookupPathPrefix(prefix) See `wx.Locale.AddCatalogLookupPathPrefix `_. **Parameters:** * `prefix` (string) -------- .. function:: Locale_AddLanguage(info) See `wx.Locale.AddLanguage `_. **Parameters:** * `info` (`wx.LanguageInfo`) -------- .. function:: Locale_FindLanguageInfo(locale) See `wx.Locale.FindLanguageInfo `_. **Parameters:** * `locale` (string) | **Returns:** `wx.LanguageInfo` -------- .. function:: Locale_GetLanguageInfo(lang) See `wx.Locale.GetLanguageInfo `_. **Parameters:** * `lang` (int) | **Returns:** `wx.LanguageInfo` -------- .. function:: Locale_GetLanguageName(lang) See `wx.Locale.GetLanguageName `_. **Parameters:** * `lang` (int) | **Returns:** `string` -------- .. function:: Locale_GetSystemEncoding() See `wx.Locale.GetSystemEncoding `_. | **Returns:** `int` -------- .. function:: Locale_GetSystemEncodingName() See `wx.Locale.GetSystemEncodingName `_. | **Returns:** `string` -------- .. function:: Locale_GetSystemLanguage() See `wx.Locale.GetSystemLanguage `_. | **Returns:** `int` -------- .. function:: Locale_IsAvailable(lang) See `wx.Locale.IsAvailable `_. **Parameters:** * `lang` (int) | **Returns:** `bool` -------- .. function:: LogDebug(msg) The right functions for debug output. They only do something in debug mode and expand to nothing in release mode (otherwise). **Parameters:** * `msg` (string) -------- .. function:: LogError(msg) The functions to use for error messages, i.e. the messages that must be shown to the user. The default processing is to pop up a message box to inform the user about it. **Parameters:** * `msg` (string) -------- .. function:: LogFatalError(msg) Like `wx.LogError <#LogError>`_, but also terminates the program with the exit code 3. **Parameters:** * `msg` (string) -------- .. function:: LogGeneric() `No docstrings available for this function.` -------- .. function:: LogInfo(msg) See `wx.LogVerbose <#LogVerbose>`_. **Parameters:** * `msg` (string) -------- .. function:: LogMessage(msg) For all normal, informational messages. They also appear in a message box by default (but it can be changed). **Parameters:** * `msg` (string) -------- .. function:: LogStatus(msg) Messages logged by these functions will appear in the statusbar of the frame or of the top level application window by default (i.e. when using the second version of the functions). If the target frame doesn't have a statusbar, the message will be lost. **Parameters:** * `msg` (string) -------- .. function:: LogStatusFrame(pFrame, msg) Messages logged by these functions will appear in the statusbar of the frame or of the top level application window by default (i.e. when using the second version of the functions). If the target frame doesn't have a statusbar, the message will be lost. **Parameters:** * `pFrame` (`wx.Frame `_) * `msg` (string) -------- .. function:: LogSysError(msg) Mostly used by wxWidgets itself, but might be handy for logging errors after system call (API function) failure. It logs the specified message text as well as the last system error code. **Parameters:** * `msg` (string) -------- .. function:: LogTrace(mask, msg) As `wx.LogDebug <#LogDebug>`, trace functions only do something in debug build and expand to nothing in the release one. The reason for making it a separate function from it is that usually there are a lot of trace messages, so it might make sense to separate them from other debug messages. The trace messages also usually can be separated into different categories and the second and third versions of this function only log the message if the mask which it has is currently enabled in `wx.Log `_. This allows to selectively trace only some operations and not others by changing the value of the trace mask (possible during the run-time). The predefined string trace masks used by wxWidgets are: * ``wx.TRACE_MemAlloc``: trace memory allocation (new/delete) * ``wx.TRACE_Messages``: trace window messages/X callbacks * ``wx.TRACE_ResAlloc``: trace GDI resource allocation * ``wx.TRACE_RefCount``: trace various ref counting operations * ``wx.TRACE_OleCalls``: trace OLE method calls (Win32 only) | **Parameters:** * `mask` (int) * `msg` (string) -------- .. function:: LogVerbose(msg) For verbose output. Normally, it is suppressed, but might be activated if the user wishes to know more details about the program progress (another, but possibly confusing name for the same function is `wx.LogInfo <#LogInfo>`_). **Parameters:** * `msg` (string) -------- .. function:: LogWarning(msg) For warnings - they are also normally shown to the user, but don't interrupt the program work. **Parameters:** * `msg` (string) -------- .. function:: Log_AddTraceMask(str) See `wx.Log.AddTraceMask `_. **Parameters:** * `str` (string) -------- .. function:: Log_ClearTraceMasks() See `wx.Log.ClearTraceMasks `_. -------- .. function:: Log_DontCreateOnDemand() See `wx.Log.DontCreateOnDemand `_. -------- .. function:: Log_EnableLogging(doIt=True) See `wx.Log.EnableLogging `_. **Parameters:** * `doIt` (bool) | **Returns:** `bool` -------- .. function:: Log_FlushActive() See `wx.Log.FlushActive `_. -------- .. function:: Log_GetActiveTarget() See `wx.Log.GetActiveTarget `_. | **Returns:** `wx.Log `_ -------- .. function:: Log_GetLogLevel() See `wx.Log.GetLogLevel `_. | **Returns:** `int` -------- .. function:: Log_GetRepetitionCounting() See `wx.Log.GetRepetitionCounting `_. | **Returns:** `bool` -------- .. function:: Log_GetTimestamp() See `wx.Log.GetTimestamp `_. | **Returns:** `string` -------- .. function:: Log_GetTraceMask() See `wx.Log.GetTraceMask `_. | **Returns:** `int` -------- .. function:: Log_GetTraceMasks() See `wx.Log.GetTraceMasks `_. | **Returns:** `list of strings` -------- .. function:: Log_GetVerbose() See `wx.Log.GetVerbose `_. | **Returns:** `bool` -------- .. function:: Log_IsAllowedTraceMask(mask) See `wx.Log.IsAllowedTraceMask `_. **Parameters:** * `mask` (wx.char) | **Returns:** `bool` -------- .. function:: Log_IsEnabled() See `wx.Log.IsEnabled `_. | **Returns:** `bool` -------- .. function:: Log_OnLog(level, szString, t) See `wx.Log.OnLog `_. **Parameters:** * `level` (int) * `szString` (string) * `t` (int) -------- .. function:: Log_RemoveTraceMask(str) See `wx.Log.RemoveTraceMask `_. **Parameters:** * `str` (string) -------- .. function:: Log_Resume() See `wx.Log.Resume `_. -------- .. function:: Log_SetActiveTarget(pLogger) See `wx.Log.SetActiveTarget `_. **Parameters:** * `pLogger` (`wx.Log `_) | **Returns:** `wx.Log `_ -------- .. function:: Log_SetLogLevel(logLevel) See `wx.Log.SetLogLevel `_. **Parameters:** * `logLevel` (int) -------- .. function:: Log_SetRepetitionCounting(bRepetCounting=True) See `wx.Log.SetRepetitionCounting `_. **Parameters:** * `bRepetCounting` (bool) -------- .. function:: Log_SetTimestamp(ts) See `wx.Log.SetTimestamp `_. **Parameters:** * `ts` (string) -------- .. function:: Log_SetTraceMask(ulMask) See `wx.Log.SetTraceMask `_. **Parameters:** * `ulMask` (int) -------- .. function:: Log_SetVerbose(bVerbose=True) See `wx.Log.SetVerbose `_. **Parameters:** * `bVerbose` (bool) -------- .. function:: Log_Suspend() See `wx.Log.Suspend `_. -------- .. function:: Log_TimeStamp() See `wx.Log.TimeStamp `_. | **Returns:** `string` -------- .. function:: MaskColour() .. warning:: `wx.MaskColour` is deprecated, use `wx.Mask `_ instead. -------- .. function:: MemoryDCFromDC(oldDC) Creates a DC that is compatible with the oldDC. **Parameters:** * `oldDC` (`wx.DC `_) | **Returns:** `wx.MemoryDC `_ -------- .. function:: MemoryFSHandler_AddFile(filename, dataItem, imgType=-1) Add `file` to the memory filesystem. The `dataItem` parameter can either be a `wx.Bitmap `_, `wx.Image `_ or a string that can contain arbitrary data. If a bitmap or image is used then the `imgType` parameter should specify what kind of image file it should be written as, ``wx.BITMAP_TYPE_PNG``, etc... **Parameters:** * `filename` (string) * `dataItem` (PyObject) * `imgType` (int) .. note:: Note that you must use a `type` value (aka image format) that wxWidgets can save (e.g. JPG, PNG, see `wx.Image `_)! -------- .. function:: MemoryFSHandler_AddFileWithMimeType(filename, data, mimetype) Like `MemoryFSHandler_AddFile <#MemoryFSHandler_AddFile>`_, but lets you explicitly specify added file's MIME type. This version should be used whenever you know the MIME type, because it makes accessing the files faster. This function is new since wxWidgets version 2.8.5 **Parameters:** * `filename` (string) * `data` (PyObject) * `mimetype` (string) -------- .. function:: MemoryFSHandler_RemoveFile(filename) Remove file from memory FS and free occupied memory. **Parameters:** * `filename` (string) -------- .. function:: MenuBar_GetAutoWindowMenu() | **Returns:** `bool` -------- .. function:: MenuBar_MacSetCommonMenuBar(menubar) | **Parameters:** * `menubar` (`wx.MenuBar `_) -------- .. function:: MenuBar_SetAutoWindowMenu(enable) | **Parameters:** * `enable` (bool) -------- .. function:: MenuItem_GetDefaultMarginWidth() | **Returns:** `int` -------- .. function:: MenuItem_GetLabelFromText(text) | **Parameters:** * `text` (string) | **Returns:** `string` -------- .. function:: MenuItem_GetLabelText(label) Strips all accelerator characters and mnemonics from the given `text`. For example:: menuItem.GetLabelFromText("&Hello\tCtrl-H") will return just ``"Hello"``. **Parameters:** * `label` (string) | **Returns:** `String` -------- .. function:: MessageBox(message, caption="", style=wx.OK|wx.CENTRE, parent=None, x=-1, y=-1) General purpose message dialog. `style` may be a bit list of the following identifiers: ============================ ================================= Style Flag Description ============================ ================================= ``wx.YES_NO`` Puts ``Yes`` and ``No`` buttons on the message box. May be combined with ``wx.CANCEL``. ``wx.CANCEL`` Puts a ``Cancel`` button on the message box. May only be combined with ``wx.YES_NO`` or ``wx.OK``. ``wx.OK`` Puts an ``Ok`` button on the message box. May be combined with ``wx.CANCEL``. ``wx.ICON_EXCLAMATION`` Displays an exclamation mark symbol. ``wx.ICON_HAND`` Displays an error symbol. ``wx.ICON_ERROR`` Displays an error symbol - the same as ``wx.ICON_HAND``. ``wx.ICON_QUESTION`` Displays a question mark symbol. ``wx.ICON_INFORMATION`` Displays an information symbol. ============================ ================================= The return value is one of: ``wx.YES``, ``wx.NO``, ``wx.CANCEL``, ``wx.OK``. For example:: answer = wx.MessageBox("Quit program?", "Confirm", wx.YES_NO | wx.CANCEL, main_frame) if answer == wx.YES: main_frame.Close() `message` may contain newline characters, in which case the message will be split into separate lines, to cater for large messages. **Parameters:** * `message` (string) * `caption` (string) * `style` (int) * `parent` (`wx.Window `_) * `x` (int) * `y` (int) | **Returns:** `int` -------- .. function:: MicroSleep(microseconds) Sleeps for the specified number of microseconds. The microsecond resolution may not, in fact, be available on all platforms (currently only Unix platforms with nanosleep(2) may provide it) in which case this is the same as `wx.MilliSleep <#MilliSleep>`_ (`microseconds`/1000). **Parameters:** * `microseconds` (int) -------- .. function:: MilliSleep(milliseconds) Sleeps for the specified number of milliseconds. **Parameters:** * `milliseconds` (int) -------- .. function:: MimeTypesManager_IsOfType(mimeType, wildcard) This function returns ``True`` if either the given `mimeType` is exactly the same as `wildcard` or if it has the same category and the subtype of `wildcard` is '\*'. The comparison don by this function is case insensitive so it is not necessary to convert the strings to the same case before calling it. **Parameters:** * `mimeType` (string) * `wildcard` (string) | **Returns:** `bool` -------- .. function:: MutexGuiEnter() This function must be called when any thread other than the main GUI thread wants to get access to the GUI library. This function will block the execution of the calling thread until the main thread (or any other thread holding the main GUI lock) leaves the GUI library and no other thread will enter the GUI library until the calling thread calls `wx.MutexGuiLeave <#MutexGuiLeave>`_. Typically, these functions are used like this:: def Foo(self): # Before doing any GUI calls we must ensure that this thread is the only # one doing it! wx.MutexGuiEnter() # Call GUI here: my_window.DrawSomething() wx.MutexGuiLeave() .. note:: Note that under GTK, no creation of top-level windows is allowed in any thread but the main one. .. note:: This function is only defined on platforms which support preemptive threads. -------- .. function:: MutexGuiLeave() See `MutexGuiEnter <#MutexGuiEnter>`_ . .. note:: This function is only defined on platforms which support preemptive threads. -------- .. function:: NamedColor(colorName) Constructs a colour object using a colour name listed in `wx.TheColourDatabase`. **Parameters:** * `colorName` (string) | **Returns:** `wx.Colour `_ -------- .. function:: NamedColour(colorName) Constructs a colour object using a colour name listed in `wx.TheColourDatabase`. **Parameters:** * `colorName` (string) | **Returns:** `wx.Colour `_ -------- .. function:: NewEventType() | **Returns:** `EventType` -------- .. function:: NewId() Generates an integer identifier unique to this run of the program. | **Returns:** `int` -------- .. function:: Notebook_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: Now() Returns a string representing the current date and time. | **Returns:** `string` -------- .. function:: NullFileTypeInfo() | **Returns:** `wx.FileTypeInfo` -------- .. function:: Panel_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: Point2DCopy(pt) Create a `wx.Point2D `_ object. **Parameters:** * `pt` (`wx.Point2D `_) | **Returns:** `wx.Point2D `_ -------- .. function:: Point2DFromPoint(pt) Create `wx.Point2D `_ object. **Parameters:** * `pt` (`wx.Point `_) | **Returns:** `wx.Point2D `_ -------- .. function:: PostEvent(dest, event) Send an event to a window or other `wx.EvtHandler` to be processed later. **Parameters:** * `dest` (`wx.EvtHandler `_) * `event` (`wx.Event `_) -------- .. function:: PostScriptDC_GetResolution() Return resolution used in PostScript output. | **Returns:** `int` -------- .. function:: PostScriptDC_SetResolution(ppi) Set resolution (in pixels per inch) that will be used in PostScript output. Default is 720ppi. **Parameters:** * `ppi` (int) -------- .. function:: PreBitmapButton() Precreate a `wx.BitmapButton` for 2-phase creation. | **Returns:** `wx.BitmapButton `_ -------- .. function:: PreButton() Precreate a `wx.Button` for 2-phase creation. | **Returns:** `wx.Button `_ -------- .. function:: PreCheckBox() Precreate a `wx.CheckBox` for 2-phase creation. | **Returns:** `wx.CheckBox `_ -------- .. function:: PreCheckListBox() Precreate a `wx.CheckListBox` for 2-phase creation. | **Returns:** `wx.CheckListBox `_ -------- .. function:: PreChoice() Precreate a `wx.Choice` control for 2-phase creation. | **Returns:** `wx.Choice `_ -------- .. function:: PreChoicebook() Precreate a `wx.Choicebook` control for 2-phase creation. | **Returns:** `wx.Choicebook `_ -------- .. function:: PreCollapsiblePane() Precreate a `wx.CollapsiblePane` for 2-phase creation. | **Returns:** `wx.CollapsiblePane `_ -------- .. function:: PreColourPickerCtrl() Precreate a `wx.ColourPickerCtrl` control for 2-phase creation. | **Returns:** `wx.ColourPickerCtrl `_ -------- .. function:: PreComboBox() Precreate a `wx.ComboBox` control for 2-phase creation. | **Returns:** `wx.ComboBox `_ -------- .. function:: PreControl() Precreate a `wx.Control` control for 2-phase creation. | **Returns:** `wx.Control `_ -------- .. function:: PreDatePickerCtrl() Precreate a `wx.DatePickerCtrl` for use in 2-phase creation. | **Returns:** `wx.DatePickerCtrl `_ -------- .. function:: PreDialog() Precreate a `wx.Dialog` control for 2-phase creation. | **Returns:** `wx.Dialog `_ -------- .. function:: PreDirFilterListCtrl() Precreate a `wx.DirFilterListCtrl` control for 2-phase creation. | **Returns:** `wx.DirFilterListCtrl `_ -------- .. function:: PreDirPickerCtrl() Precreate a `wx.DirPickerCtrl` control for 2-phase creation. | **Returns:** `wx.DirPickerCtrl `_ -------- .. function:: PreFilePickerCtrl() Precreate a `wx.FilePickerCtrl` control for 2-phase creation. | **Returns:** `wx.FilePickerCtrl `_ -------- .. function:: PreFindReplaceDialog() Precreate a `wx.FindReplaceDialog` for 2-phase creation. | **Returns:** `wx.FindReplaceDialog `_ -------- .. function:: PreFontPickerCtrl() Precreate a `wx.FontPickerCtrl` control for 2-phase creation. | **Returns:** `wx.FontPickerCtrl `_ -------- .. function:: PreFrame() Precreate a `wx.Frame` control for 2-phase creation. | **Returns:** `wx.Frame `_ -------- .. function:: PreGauge() Precreate a `wx.Gauge` control for 2-phase creation. | **Returns:** `wx.Gauge `_ -------- .. function:: PreGenericDatePickerCtrl() Precreate a `wx.GenericDatePickerCtrl` for use in 2-phase creation. | **Returns:** `wx.GenericDatePickerCtrl `_ -------- .. function:: PreGenericDirCtrl() Precreate a `wx.GenericDirCtrl` control for 2-phase creation. | **Returns:** `wx.GenericDirCtrl `_ -------- .. function:: PreHtmlListBox() Precreate a `wx.HtmlListBox` control for 2-phase creation. | **Returns:** `wx.HtmlListBox `_ -------- .. function:: PreHyperlinkCtrl() Precreate a `wx.HyperlinkCtrl` control for 2-phase creation. | **Returns:** `wx.HyperlinkCtrl `_ -------- .. function:: PreListBox() Precreate a `wx.ListBox` control for 2-phase creation. | **Returns:** `wx.ListBox `_ -------- .. function:: PreListCtrl() Precreate a `wx.ListCtrl` control for 2-phase creation. | **Returns:** `wx.ListCtrl `_ -------- .. function:: PreListView() Precreate a `wx.ListView` control for 2-phase creation. | **Returns:** `wx.ListView `_ -------- .. function:: PreListbook() Precreate a `wx.Listbook` control for 2-phase creation. | **Returns:** `wx.Listbook `_ -------- .. function:: PreMDIChildFrame() Precreate a `wx.MDIChildFrame` control for 2-phase creation. | **Returns:** `wx.MDIChildFrame `_ -------- .. function:: PreMDIClientWindow() Precreate a `wx.MDIClientWindow` control for 2-phase creation. | **Returns:** `wx.MDIClientWindow `_ -------- .. function:: PreMDIParentFrame() Precreate a `wx.MDIParentFrame` control for 2-phase creation. | **Returns:** `wx.MDIParentFrame `_ -------- .. function:: PreMiniFrame() Precreate a `wx.MiniFrame` control for 2-phase creation. | **Returns:** `wx.MiniFrame `_ -------- .. function:: PreNotebook() Precreate a `wx.Notebook` control for 2-phase creation. | **Returns:** `wx.Notebook `_ -------- .. function:: PrePanel() Precreate a `wx.Panel` control for 2-phase creation. | **Returns:** `wx.Panel `_ -------- .. function:: PrePopupTransientWindow() Precreate a `wx.PopupTransientWindow` control for 2-phase creation. | **Returns:** `wx.PopupTransientWindow` -------- .. function:: PrePopupWindow() Precreate a `wx.PopupWindow` control for 2-phase creation. | **Returns:** `wx.PopupWindow` -------- .. function:: PrePyAxBaseWindow() Precreate a `wx.PyAxBaseWindow` control for 2-phase creation. | **Returns:** `wx.PyAxBaseWindow `_ -------- .. function:: PrePyControl() Precreate a `wx.PyControl` control for 2-phase creation. | **Returns:** `wx.PyControl `_ -------- .. function:: PrePyPanel() Precreate a `wx.PyPanel` control for 2-phase creation. | **Returns:** `wx.PyPanel `_ -------- .. function:: PrePyScrolledWindow() Precreate a `wx.PyScrolledWindow` control for 2-phase creation. | **Returns:** `wx.PyScrolledWindow `_ -------- .. function:: PrePyWindow() Precreate a `wx.PyWindow` control for 2-phase creation. | **Returns:** `wx.PyWindow `_ -------- .. function:: PreRadioBox() Precreate a `wx.RadioBox` control for 2-phase creation. | **Returns:** `wx.RadioBox `_ -------- .. function:: PreRadioButton() Precreate a `wx.RadioButton` control for 2-phase creation. | **Returns:** `wx.RadioButton `_ -------- .. function:: PreSashLayoutWindow() Precreate a `wx.SashLayoutWindow` control for 2-phase creation. | **Returns:** `wx.SashLayoutWindow `_ -------- .. function:: PreSashWindow() Precreate a `wx.SashWindow` control for 2-phase creation. | **Returns:** `wx.SashWindow `_ -------- .. function:: PreScrollBar() Precreate a `wx.ScrollBar` control for 2-phase creation. | **Returns:** `wx.ScrollBar `_ -------- .. function:: PreScrolledWindow() Precreate a `wx.ScrolledWindow` control for 2-phase creation. | **Returns:** `wx.ScrolledWindow `_ -------- .. function:: PreSearchCtrl() Precreate a `wx.SearchCtrl` for 2-phase creation. | **Returns:** `wx.SearchCtrl `_ -------- .. function:: PreSimpleHtmlListBox() Precreate a `wx.SimpleHtmlListBox` control for 2-phase creation. | **Returns:** `wx.SimpleHtmlListBox `_ -------- .. function:: PreSingleInstanceChecker() Precreate a `wx.SingleInstanceChecker` control for 2-phase creation. | **Returns:** `wx.SingleInstanceChecker `_ -------- .. function:: PreSlider() Precreate a `wx.Slider` control for 2-phase creation. | **Returns:** `wx.Slider `_ -------- .. function:: PreSpinButton() Precreate a `wx.SpinButton` control for 2-phase creation. | **Returns:** `wx.SpinButton `_ -------- .. function:: PreSpinCtrl() Precreate a `wx.SpinCtrl` control for 2-phase creation. | **Returns:** `wx.SpinCtrl `_ -------- .. function:: PreSplitterWindow() Precreate a `wx.SplitterWindow` for 2-phase creation. | **Returns:** `wx.SplitterWindow `_ -------- .. function:: PreStaticBitmap() Precreate a `wx.StaticBitmap` control for 2-phase creation. | **Returns:** `wx.StaticBitmap `_ -------- .. function:: PreStaticBox() Precreate a `wx.StaticBox` control for 2-phase creation. | **Returns:** `wx.StaticBox `_ -------- .. function:: PreStaticLine() Precreate a `wx.StaticLine` control for 2-phase creation. | **Returns:** `wx.StaticLine `_ -------- .. function:: PreStaticText() Precreate a `wx.StaticText` control for 2-phase creation. | **Returns:** `wx.StaticText `_ -------- .. function:: PreStatusBar() Precreate a `wx.StatusBar` control for 2-phase creation. | **Returns:** `wx.StatusBar `_ -------- .. function:: PreTextCtrl() Precreate a `wx.TextCtrl` control for 2-phase creation. | **Returns:** `wx.TextCtrl `_ -------- .. function:: PreToggleButton() Precreate a `wx.ToggleButton` control for 2-phase creation. | **Returns:** `wx.ToggleButton `_ -------- .. function:: PreToolBar() Precreate a `wx.ToolBar` control for 2-phase creation. | **Returns:** `wx.ToolBar `_ -------- .. function:: PreToolbook() Precreate a `wx.Toolbook` control for 2-phase creation. | **Returns:** `wx.Toolbook `_ -------- .. function:: PreTreeCtrl() Precreate a `wx.TreeCtrl` control for 2-phase creation. | **Returns:** `wx.TreeCtrl `_ -------- .. function:: PreTreebook() Precreate a `wx.Treebook` control for 2-phase creation. | **Returns:** `wx.Treebook `_ -------- .. function:: PreVListBox() Precreate a `wx.VListBox` control for 2-phase creation. | **Returns:** `wx.VListBox `_ -------- .. function:: PreVScrolledWindow() Precreate a `wx.VScrolledWindow` control for 2-phase creation. | **Returns:** `wx.VScrolledWindow `_ -------- .. function:: PreWindow() Precreate a `wx.Window` for 2-phase creation. | **Returns:** `wx.Window `_ -------- .. function:: Printer_GetLastError() See `wx.Printer.GetLastError `_. | **Returns:** `int` -------- .. function:: Process_Exists(pid) See `wx.Process.Exists `_. **Parameters:** * `pid` (int) | **Returns:** `bool` -------- .. function:: Process_Kill(pid, sig=wx.SIGTERM, flags=wx.KILL_NOCHILDREN) See `wx.Process.Kill `_. **Parameters:** * `pid` (int) * `sig` (int) * `flags` (int) | **Returns:** `int` -------- .. function:: Process_Open(cmd, flags=wx.EXEC_ASYNC) See `wx.Process.Open `_. **Parameters:** * `cmd` (string) * `flags` (int) | **Returns:** `wx.Process `_ -------- .. function:: PyApp_GetComCtl32Version() Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if it wasn't found at all. Raises an exception on non-Windows platforms. | **Returns:** `int` -------- .. function:: PyApp_GetMacAboutMenuItemId() | **Returns:** `int` -------- .. function:: PyApp_GetMacExitMenuItemId() | **Returns:** `int` -------- .. function:: PyApp_GetMacHelpMenuTitleName() | **Returns:** `String` -------- .. function:: PyApp_GetMacPreferencesMenuItemId() | **Returns:** `int` -------- .. function:: PyApp_GetMacSupportPCMenuShortcuts() | **Returns:** `bool` -------- .. function:: PyApp_IsDisplayAvailable() Tests if it is possible to create a GUI in the current environment. This will mean different things on the different platforms. * On X Windows systems this function will return ``False`` if it is not able to open a connection to the X display, which can happen if $DISPLAY is not set, or is not set correctly. * On Mac OS X a ``False`` return value will mean that wxPython is not able to access the window manager, which can happen if logged in remotely or if running from the normal version of python instead of the framework version, (i.e., ``pythonw``). * On MS Windows... | **Returns:** `bool` -------- .. function:: PyApp_IsMainLoopRunning() Returns ``True`` if we're running the main loop, i.e. if the events can currently be dispatched. | **Returns:** `bool` -------- .. function:: PyApp_SetMacAboutMenuItemId(val) | **Parameters:** * `val` (long) -------- .. function:: PyApp_SetMacExitMenuItemId(val) | **Parameters:** * `val` (long) -------- .. function:: PyApp_SetMacHelpMenuTitleName(val) | **Parameters:** * `val` (string) -------- .. function:: PyApp_SetMacPreferencesMenuItemId(val) | **Parameters:** * `val` (long) -------- .. function:: PyApp_SetMacSupportPCMenuShortcuts(val) | **Parameters:** * `val` (bool) -------- .. function:: PyAxBaseWindow_FromHWND() `No docstrings available for this function.` -------- .. function:: Quantize_Quantize(src, dest, desiredNoColours=236, flags=wx.QUANTIZE_INCLUDE_WINDOWS_COLOURS | wx.QUANTIZE_FILL_DESTINATION_IMAGE) Reduce the colours in the source image and put the result into the destination image, setting the palette in the destination if needed. Both images may be the same, to overwrite the source image. **Parameters:** * `src` (`wx.Image `_) * `dest` (`wx.Image `_) * `desiredNoColours` (int) * `flags` (int) | **Returns:** `bool` -------- .. function:: RadioBox_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: RadioButton_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: RectPP(topLeft, bottomRight) Create a new `wx.Rect `_ object from Points representing two corners. **Parameters:** * `topLeft` (`wx.Point `_) * `bottomRight` (`wx.Point `_) | **Returns:** `wx.Rect `_ -------- .. function:: RectPS(pos, size) Create a new `wx.Rect `_ from a position and size. **Parameters:** * `pos` (`wx.Point `_) * `size` (`wx.Size `_) | **Returns:** `wx.Rect `_ -------- .. function:: RectS(size) Create a new `wx.Rect `_ from a size only. **Parameters:** * `size` (`wx.Size `_) | **Returns:** `wx.Rect `_ -------- .. function:: RegionFromBitmap(bmp) Creates a `wx.Region `_ from a bitmap. **Parameters:** * `bmp` (`wx.Bitmap `_) | **Returns:** `wx.Region `_ -------- .. function:: RegionFromBitmapColour(bmp, transColour, tolerance=0) Converts the non-transparent pixels of a bitmap into a region. Colour to be treated as transparent is specified in the `transColour` argument, along with an optional colour tolerance value. **Parameters:** * `bmp` (`wx.Bitmap `_) * `transColour` (`wx.Colour `_) * `tolerance` (int) | **Returns:** `wx.Region `_ -------- .. function:: RegionFromPoints(points, fillStyle=wx.WINDING_RULE) Creates a `wx.Region `_ from a list of points **Parameters:** * `points` (list of `wx.Point `_) * `fillStyle` (int) | **Returns:** `wx.Region `_ -------- .. function:: RegisterId(id) Ensures that ids subsequently generated by `wx.NewId <#NewId>`_ do not clash with the given `id`. **Parameters:** * `id` (long) -------- .. function:: RendererNative_Get() Return the currently used renderer. | **Returns:** `wx.RendererNative `_ -------- .. function:: RendererNative_GetDefault() Return the default (native) implementation for this platform -- this is also the one used by default but this may be changed by calling `wx.RendererNative.Set `_ in which case the return value of this method may be different from the return value of `wx.RendererNative.Get `_. | **Returns:** `wx.RendererNative `_ -------- .. function:: RendererNative_GetGeneric() Return the generic implementation of the renderer. Under some platforms, this is the default renderer implementation, others have platform-specific default renderer which can be retrieved by calling `wx.RendererNative.GetDefault `_. | **Returns:** `wx.RendererNative `_ -------- .. function:: RendererNative_Set(renderer) Set the renderer to use, passing ``None`` reverts to using the default renderer. Returns the previous renderer used with `Set `_ or ``None``. **Parameters:** * `renderer` (`wx.RendererNative `_) | **Returns:** `wx.RendererNative `_ -------- .. function:: RendererVersion_IsCompatible(ver) See `wx.RendererVersion.IsCompatible `_. **Parameters:** * `ver` (`wx.RendererVersion `_) | **Returns:** `bool` -------- .. function:: Renderer_DrawChoice(win, dc, rect, flags=0) See `wx.RendererNative.DrawChoice `_. **Parameters:** * `win` (`wx.Window `_) * `dc` (`wx.DC `_) * `rect` (`wx.Rect `_) * `flags` (int) -------- .. function:: Renderer_DrawComboBox(win, dc, rect, flags=0) See `wx.RendererNative.DrawComboBox `_. **Parameters:** * `win` (`wx.Window `_) * `dc` (`wx.DC `_) * `rect` (`wx.Rect `_) * `flags` (int) -------- .. function:: Renderer_DrawRadioButton(win, dc, rect, flags=0) See `wx.RendererNative.DrawRadioButton `_. **Parameters:** * `win` (`wx.Window `_) * `dc` (`wx.DC `_) * `rect` (`wx.Rect `_) * `flags` (int) -------- .. function:: Renderer_DrawTextCtrl(win, dc, rect, flags=0) See `wx.RendererNative.DrawTextCtrl `_. **Parameters:** * `win` (`wx.Window `_) * `dc` (`wx.DC `_) * `rect` (`wx.Rect `_) * `flags` (int) -------- .. function:: SafeShowMessage(title, text) This function shows a message to the user in a safe way and should be safe to call even before the application has been initialized or if it is currently in some other strange state (for example, about to crash). Under Windows this function shows a message box using a native dialog instead of `wx.MessageBox <#MessageBox>`_ (which might be unsafe to call), elsewhere it simply prints the message to the standard output using the title as prefix. **Parameters:** * `title` (string): The title of the message box shown to the user or the prefix of the message string. * `text` (string): The text to show to the user. -------- .. function:: SafeYield(win=None, onlyIfNeeded=False) This function is similar to `wx.Yield <#Yield>`_, except that it disables the user input to all program windows before calling `wx.Yield <#Yield>`_ and re-enables it again afterwards. If `win` is not ``None``, this window will remain enabled, allowing the implementation of some limited user interaction. Returns the result of the call to `wx.Yield <#Yield>`_. **Parameters:** * `win` (`wx.Window `_) * `onlyIfNeeded` (bool) | **Returns:** `bool` -------- .. function:: SaveFileSelector(what, extension, default_name="", parent=None) | **Parameters:** * `what` (string) * `extension` (string) * `default_name` (string) * `parent` (`wx.Window `_) | **Returns:** `string` -------- .. function:: ScrollBar_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: ScrolledWindow_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: SetCursor(cursor) Globally sets the cursor; only has an effect on Windows, Mac and GTK+. You should call this function with `wx.NullCursor` as parameter to restore the system cursor. **Parameters:** * `cursor` (`wx.Cursor `_) .. seealso:: `wx.Cursor `_, `wx.Window.SetCursor `_ -------- .. function:: SetDefaultPyEncoding(encoding) Sets the encoding that wxPython will use when it needs to convert a Python string or unicode object to or from a wxString. The default encoding is the value of ``locale.getdefaultlocale()[1]`` but please be aware that the default encoding within the same locale may be slightly different on different platforms. For example, please see http://www.alanwood.net/demos/charsetdiffs.html for differences between the common latin/roman encodings. **Parameters:** * `encoding` (string) -------- .. function:: Shell(command="") Executes a command in an interactive shell window. If no command is specified, then just the shell is spawned. **Parameters:** * `command` (string) | **Returns:** `bool` .. seealso:: `Execute <#Execute>`_ -------- .. function:: ShowTip(parent, tipProvider, showAtStartup=True) This function shows a "startup tip" to the user. The return value is the state of the 'Show tips at startup' checkbox. **Parameters:** * `parent` (`wx.Window `_): The parent window of the modal dialog. * `tipProvider` (`wx.TipProvider `_): An object which is used to get the text of the tips. It may be created with the `wx.CreateFileTipProvider <#CreateFileTipProvider>`_ function. * `showAtStartup` (bool): Should be ``True`` if startup tips are shown, ``False`` otherwise. This is used as the initial value for "Show tips at startup" checkbox which is shown in the tips dialog. | **Returns:** `bool` -------- .. function:: Shutdown(wFlags) This function shuts down or reboots the computer depending on the value of the flags. Please notice that doing this requires the corresponding access rights (superuser under Unix, SE_SHUTDOWN privilege under Windows NT) and that this function is only implemented under Unix and Win32. **Parameters:** * `wFlags` (int) | **Returns:** `bool` -------- .. function:: SizerFlags_GetDefaultBorder() Returns the default border size used by the other border methods. | **Returns:** `int` -------- .. function:: SizerItemSizer(sizer, proportion, flag, border, userData=None) Constructs a `wx.SizerItem `_ for tracking a subsizer. **Parameters:** * `sizer` (`wx.Sizer `_) * `proportion` (int) * `flag` (int) * `border` (int) * `userData` (PyObject) | **Returns:** `wx.SizerItem `_ -------- .. function:: SizerItemSpacer(width, height, proportion, flag, border, userData=None) Constructs a `wx.SizerItem `_ for tracking a spacer. **Parameters:** * `width` (int) * `height` (int) * `proportion` (int) * `flag` (int) * `border` (int) * `userData` (PyObject) | **Returns:** `wx.SizerItem `_ -------- .. function:: SizerItemWindow(window, proportion, flag, border, userData=None) Constructs a `wx.SizerItem `_ for tracking a window. **Parameters:** * `window` (`wx.Window `_) * `proportion` (int) * `flag` (int) * `border` (int) * `userData` (PyObject) | **Returns:** `wx.SizerItem `_ -------- .. function:: Sleep(secs) Sleeps for the specified number of seconds. **Parameters:** * `secs` (int) -------- .. function:: Slider_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: SoundFromData(data) Creates a `wx.Sound `_ from the input data. **Parameters:** * `data` (PyObject) | **Returns:** `wx.Sound `_ -------- .. function:: Sound_PlaySound(filename, flags=wx.SOUND_ASYNC) See `wx.Sound.Play `_ **Parameters:** * `filename` (string) * `flags` (int) -------- .. function:: Sound_Stop() See `wx.Sound.Stop `_ -------- .. function:: SpinButton_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: SpinCtrl_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: SplitterWindow_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: StandardPaths_Get() Return the global standard paths singleton. | **Returns:** `wx.StandardPaths `_ -------- .. function:: StartTimer() Starts a stopwatch; use `wx.GetElapsedTime <#GetElapsedTime>`_ to get the elapsed time. .. seealso:: `wx.Timer `_ -------- .. function:: StaticBitmap_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: StaticBox_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: StaticLine_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: StaticLine_GetDefaultSize() | **Returns:** `int` -------- .. function:: StaticText_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: StatusBar_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: StockCursor(id) Create a cursor using one of the stock cursors. **Parameters:** * `id` (int) | **Returns:** `wx.Cursor `_ .. note:: Note that not all stock cursors are available on all platforms. -------- .. function:: StockGDI_DeleteAll() `No docstrings available for this function.` -------- .. function:: StockGDI_GetBrush(item) | **Parameters:** * `item` (int) | **Returns:** `wx.Brush `_ -------- .. function:: StockGDI_GetColour(item) | **Parameters:** * `item` (int) | **Returns:** `wx.Colour `_ -------- .. function:: StockGDI_GetCursor(item) | **Parameters:** * `item` (int) | **Returns:** `wx.Cursor `_ -------- .. function:: StockGDI_GetPen(item) | **Parameters:** * `item` (int) | **Returns:** `wx.Pen `_ -------- .. function:: StockGDI_instance() | **Returns:** `wx.StockGDI `_ -------- .. function:: StripMenuCodes(in) Strips any menu codes from `in` and returns the result. By default, the functions strips both the mnemonics character ('&') which is used to indicate a keyboard shortkey, and the accelerators, which are used only in the menu items and are separated from the main text by the ``\t`` (``TAB``) character. **Parameters:** * `in` (string) | **Returns:** `string` .. note:: Notice that in most cases `wx.MenuItem.GetLabelFromText `_ or `wx.Control.GetLabelText `_ can be used instead. -------- .. function:: SysErrorCode() Returns the error code from the last system call. This function uses `errno` on Unix platforms and `GetLastError` under Win32. | **Returns:** `int` .. seealso:: `wx.SysErrorMsg <#SysErrorMsg>`_, `wx.LogSysError <#LogSysError>`_ -------- .. function:: SysErrorMsg(nErrCode=0) Returns the error message corresponding to the given system error code. If `errCode` is 0 (default), the last error code (as returned by `wx.SysErrorCode <#SysErrorCode>`_) is used. .. seealso:: `wx.SysErrorCode <#SysErrorCode>`_, `wx.LogSysError <#LogSysError>`_ -------- .. function:: SystemOptions_GetOption(name) See `wx.SystemOptions.GetOption `_ **Parameters:** * `name` (string) | **Returns:** `String` -------- .. function:: SystemOptions_GetOptionInt(name) See `wx.SystemOptions.GetOptionInt `_ **Parameters:** * `name` (string) | **Returns:** `int` -------- .. function:: SystemOptions_HasOption(name) See `wx.SystemOptions.HasOption `_ **Parameters:** * `name` (string) | **Returns:** `bool` -------- .. function:: SystemOptions_IsFalse(name) See `wx.SystemOptions.IsFalse `_ **Parameters:** * `name` (string) | **Returns:** `bool` -------- .. function:: SystemOptions_SetOption(name, value) See `wx.SystemOptions.SetOption `_ **Parameters:** * `name` (string) * `value` (string) -------- .. function:: SystemOptions_SetOptionInt(name, value) See `wx.SystemOptions.SetOptionInt `_ **Parameters:** * `name` (string) * `value` (int) -------- .. function:: SystemSettings_GetColour(index) See `wx.SystemSettings.GetColour `_ **Parameters:** * `index` (int) | **Returns:** `wx.Colour `_ -------- .. function:: SystemSettings_GetFont(index) See `wx.SystemSettings.GetFont `_ **Parameters:** * `index` (int) | **Returns:** `wx.Font `_ -------- .. function:: SystemSettings_GetMetric(index, win=None) See `wx.SystemSettings.GetMetric `_ **Parameters:** * `index` (int) * `win` (`wx.Window `_) | **Returns:** `int` -------- .. function:: SystemSettings_GetScreenType() See `wx.SystemSettings.GetScreenType `_ | **Returns:** `int` -------- .. function:: SystemSettings_HasFeature(index) See `wx.SystemSettings.HasFeature `_ **Parameters:** * `index` (int) | **Returns:** `bool` -------- .. function:: SystemSettings_SetScreenType(screen) See `wx.SystemSettings.SetScreenType `_ **Parameters:** * `screen` (int) -------- .. function:: TestFontEncoding(info) | **Parameters:** * `info` (`wx.NativeEncodingInfo`) | **Returns:** `bool` -------- .. function:: TextAttr_Combine(attr, attrDef, text) | **Parameters:** * `attr` (`wx.TextAttr `_) * `attrDef` (`wx.TextAttr `_) * `text` (`wx.TextCtrl `_) | **Returns:** `wx.TextAttr `_ -------- .. function:: TextAttr_Merge(base, overlay) Creates a new `wx.TextAttr` which is a merge of `base` and `overlay`. Properties defined in `overlay` take precedence over those in `base`. Properties undefined/invalid in both are undefined in the result. **Parameters:** * `base` (`wx.TextAttr `_) * `overlay` (`wx.TextAttr `_) | **Returns:** `wx.TextAttr `_ -------- .. function:: TextCtrl_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: Thread_IsMain() Returns ``True`` if this thread is the main one. | **Returns:** `bool` -------- .. function:: TimeSpan_Day() See `wx.TimeSpan.Day `_ **Returns:** `wx.TimeSpan `_ -------- .. function:: TimeSpan_Days(days) See `wx.TimeSpan.Days `_ **Parameters:** * `days` (long) | **Returns:** `wx.TimeSpan `_ -------- .. function:: TimeSpan_Hour() See `wx.TimeSpan.Hour `_ | **Returns:** `wx.TimeSpan `_ -------- .. function:: TimeSpan_Hours(hours) See `wx.TimeSpan.Hours `_ **Parameters:** * `hours` (long) | **Returns:** `wx.TimeSpan `_ -------- .. function:: TimeSpan_Millisecond() See `wx.TimeSpan.Millisecond `_ | **Returns:** `wx.TimeSpan `_ -------- .. function:: TimeSpan_Milliseconds(ms) See `wx.TimeSpan.Milliseconds `_ **Parameters:** * `ms` (long) | **Returns:** `wx.TimeSpan `_ -------- .. function:: TimeSpan_Minute() See `wx.TimeSpan.Minute `_ | **Returns:** `wx.TimeSpan `_ -------- .. function:: TimeSpan_Minutes(min) See `wx.TimeSpan.Minutes `_ **Parameters:** * `min` (long) | **Returns:** `wx.TimeSpan `_ -------- .. function:: TimeSpan_Second() See `wx.TimeSpan.Second `_ | **Returns:** `wx.TimeSpan `_ -------- .. function:: TimeSpan_Seconds(sec) See `wx.TimeSpan.Seconds `_ **Parameters:** * `sec` (long) | **Returns:** `wx.TimeSpan `_ -------- .. function:: TimeSpan_Week() See `wx.TimeSpan.Week `_ **Returns:** `wx.TimeSpan `_ -------- .. function:: TimeSpan_Weeks(days) See `wx.TimeSpan.Weeks `_ **Parameters:** * `days` (long) | **Returns:** `wx.TimeSpan `_ -------- .. function:: ToggleButton_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: ToolBar_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: ToolTip_Enable(flag) See `wx.ToolTip.Enable `_ **Parameters:** * `flag` (bool) -------- .. function:: ToolTip_SetDelay(milliseconds) See `wx.ToolTip.SetDelay `_ **Parameters:** * `milliseconds` (long) -------- .. function:: Trap() In debug mode this function generates a debugger exception meaning that the control is passed to the debugger if one is attached to the process. Otherwise the program just terminates abnormally. In release mode this function does nothing. -------- .. function:: TreeCtrl_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: UpdateUIEvent_CanUpdate(win) Returns ``True`` if it is appropriate to update (send UI update events to) this window. This function looks at the mode used (see `wx.UpdateUIEvent.SetMode `_), the ``wx.WS_EX_PROCESS_UPDATE_EVENTS`` flag in window, the time update events were last sent in idle time, and the update interval, to determine whether events should be sent to this window now. By default this will always return true because the update mode is initially ``wx.UPDATE_UI_PROCESS_ALL`` and the interval is set to 0; so update events will be sent as often as possible. You can reduce the frequency that events are sent by changing the mode and/or setting an update interval. **Parameters:** * `win` (`wx.Window `_) | **Returns:** `bool` -------- .. function:: UpdateUIEvent_GetMode() Returns a value specifying how wxWidgets will send update events: to all windows, or only to those which specify that they will process the events. | **Returns:** `int` -------- .. function:: UpdateUIEvent_GetUpdateInterval() Returns the current interval between updates in milliseconds. Set -1 to disable updates, 0 to update as frequently as possible. | **Returns:** `int` -------- .. function:: UpdateUIEvent_ResetUpdateTime() Used internally to reset the last-updated time to the current time. It is assumed that update events are normally sent in idle time, so this is called at the end of idle processing. -------- .. function:: UpdateUIEvent_SetMode(mode) Specify how wxWidgets will send update events: to all windows, or only to those which specify that they will process the events. `mode` may be one of the following values: * ``wx.UPDATE_UI_PROCESS_ALL``, Send UI update events to all windows * ``wx.UPDATE_UI_PROCESS_SPECIFIED``, Send UI update events to windows that have the ``wx.WS_EX_PROCESS_UI_UPDATES`` flag specified The default is ``wx.UPDATE_UI_PROCESS_ALL``. **Parameters:** * `mode` (int) -------- .. function:: UpdateUIEvent_SetUpdateInterval(updateInterval) Sets the interval between updates in milliseconds. Set to -1 to disable updates, or to 0 to update as frequently as possible. The default is 0. Use this to reduce the overhead of UI update events if your application has a lot of windows. If you set the value to -1 or greater than 0, you may also need to call `wx.Window.UpdateWindowUI `_ at appropriate points in your application, such as when a dialog is about to be shown. **Parameters:** * `updateInterval` (long) -------- .. function:: Usleep(secs) Sleeps for the specified number of seconds. **Parameters:** * `secs` (int) -------- .. function:: Validator_IsSilent() See `wx.Validator.IsSilent `_ | **Returns:** `bool` -------- .. function:: Validator_SetBellOnError(doIt=True) See `wx.Validator.SetBellOnError `_ **Parameters:** * `doIt` (int) -------- .. function:: version() Returns a string containing version and port info. | **Returns:** `string` -------- .. function:: WakeUpIdle() This functions wakes up the (internal and platform dependent) idle system, i.e. it will force the system to send an idle event even if the system currently is idle and thus would not send any idle event until after some other event would get sent. This is also useful for sending events between two threads and is used by the corresponding functions `wx.PostEvent <#PostEvent>`_ and `wx.EvtHandler.AddPendingEvent `_. -------- .. function:: WakeUpMainThread() `No docstrings available for this function.` -------- .. function:: Window_FindFocus() Returns the window or control that currently has the keyboard focus, or ``None``. | **Returns:** `wx.Window `_ -------- .. function:: Window_FromHWND() `No docstrings available for this function.` -------- .. function:: Window_GetCapture() Returns the window which currently captures the mouse or ``None``. | **Returns:** `wx.Window `_ -------- .. function:: Window_GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) 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. **Parameters:** * `variant` (int) | **Returns:** `wx.VisualAttributes` -------- .. function:: Window_NewControlId() Generate a control id for the controls which were not given one. | **Returns:** `int` -------- .. function:: Window_NextControlId(winid) Get the id of the control following the one with the given autogenerated) `winid`. **Parameters:** * `winid` (int) | **Returns:** `int` -------- .. function:: Window_PrevControlId(winid) Get the id of the control preceding the one with the given autogenerated) `winid`. **Parameters:** * `winid` (int) | **Returns:** `int` -------- .. function:: Yield() Yield to other apps/messages. Convenience for `wx.GetApp().Yield()`. | **Returns:** `bool` .. note:: This function is kept only for backwards compatibility. Please use the `wx.GetApp().Yield()` method instead in any new code. -------- .. function:: YieldIfNeeded() Yield to other apps/messages. Convenience for `wx.GetApp().Yield(True)`. | **Returns:** `bool`