wxPython官方文档中文翻译 - wx函数

178 阅读42分钟

官方文档:docs.wxpython.org/wx.function…

本文描述了wx模块中定义的函数和宏:你可以根据函数的字母顺序列表来查找某个函数。

A

wx.Abort

wx.Abort()

立即退出程序。

该函数是对标准abort()函数的一个简单封装。

2.9.4版本新增

wx.AutoBufferedPaintDCFactory

wx.AutoBufferedPaintDCFactory (window)

检查该窗口是否是原生双缓冲的,如果是则返回一个wx.PaintDC,否则返回一个wx.BufferedPaintDC

调用者有责任在使用完wx.DC指针后将其删除。

参数:

window(wx.Window) –

返回类型:

wx.DC

B

wx.BeginBusyCursor

wx.BeginBusyCursor (cursor=HOURGLASS_CURSOR)

将应用程序中所有窗口的光标更改为给定的光标。

使用wx.EndBusyCursor将光标恢复到其先前的状态。这两个调用可以嵌套使用,并且有一个计数器确保只有最外层的调用会生效。

参数:

cursor(wx.Cursor) –

另请参阅: wx.IsBusywx.BusyCursor

wx.Bell

wx.Bell()

触发系统铃声。

注意:此函数被归类为GUI函数,因此不是线程安全的。

wx.BitmapFromBuffer

wx.BitmapFromBuffer (width, height, dataBuffer, alphaBuffer=None)

wx.Bitmap.FromBufferwx.Bitmap.FromBufferAndAlpha的的兼容性封装函数。

wx.BitmapFromBufferRGBA

wx.BitmapFromBufferRGBA (width, height, dataBuffer)

wx.Bitmap.FromBufferRGBA兼容性封装函数。

wx.BitmapFromImage

wx.BitmapFromImage(image)

wx.Bitmap(wx.Image)构造函数的兼容性封装函数。

C

wx.CallAfter

wx.CallAfter *(callableObj, *args, *kw)

在当前及待处理的事件处理程序执行完毕后,调用指定的函数。这对于从GUI线程调用GUI方法也很有用。在调用可调用对象时,任何额外的位置参数或关键字参数都会传递给该可调用对象。

参数:

  • callableObj (PyObject) – 可调用对象
  • args – 要传递给可调用对象的参数
  • kw – 要传递给可调用对象的关键字参数

另请参阅wx.CallLater

wx.CheckOsVersion

wx.CheckOsVersion (majorVsn, minorVsn=0, microVsn=0)

Returns True if the version of the operating system on which the program is running under is the same or later than the given version.

如果程序正在运行的操作系统版本与给定版本相同或更高,则返回True

参数:

  • majorVsn (int) –
  • minorVsn (int) –
  • microVsn (int) –

返回类型:

bool

4.1版本/wxWidgets-3.1.0新增。

另请参阅wx.GetOsVersion , PlatformInfo

wx.ClientDisplayRect

wx.ClientDisplayRect()

返回显示器上工作区域的尺寸。

wx.GetClientDisplayRect相同,但允许检索各个组成部分,而不是整个矩形区域。

如果调用者不需要相应的值,那么任何一个输出指针都可以为None

返回类型:

tuple

返回:

(x, y, width, height)

另请参阅wx.Display

wx.ColourDisplay

wx.ColourDisplay()

如果显示器是彩色的,则返回True,否则返回False

返回类型:

bool

注意:不建议在新代码中使用此函数,因为它仅适用于主显示器。应使用wx.Display.GetDepth来检索相应显示器的色彩深度,然后将其与1进行比较。

D

wx.date2pydate

wx.date2pydate (date)

将一个DateTime对象转换为Python的datetime对象。

wx.DateTimeFromDMY

wx.DateTimeFromDMY (day, month, year=DateTime.Inv_Year, hour=0, minute=0, second=0, millisecond=0)

DateTime.FromDMY的兼容性封装函数。

wx.DateTimeFromHMS

wx.DateTimeFromHMS (hour, minute=0, second=0, millisecond=0)

DateTime.FromHMS的兼容性封装函数。

wx.DateTimeFromJDN

wx.DateTimeFromJDN (jdn)

DateTime.FromJDN的兼容性封装函数。

wx.DateTimeFromTimeT

wx.DateTimeFromTimeT (timet)

DateTime.FromTimeT的兼容性封装函数。

wx.DecToHex

wx.DecToHex *(*args, *kw)

重载实现:


DecToHex (dec, buf)

将十进制整数转换为两位字符的十六进制字符串。

参数:

  • dec (int) – 要进行转换的数字。

  • buf (wx.Char) – 指向接收十六进制字符串(前面没有0x前缀)的缓冲区的指针。该缓冲区应足够大,至少能容纳3个字符:2个十六进制数字和终止的空字符。

注意:返回的字符串由大写的十六进制字符组成。

DecToHex (dec) 将十进制整数转换为两位字符的十六进制字符串。

参数:

dec (int) – 要进行转换的数字。

返回类型:

string

返回:

包含十六进制字符串的字符串,无前缀0x,由大写字符组成。


DecToHex (dec, ch1, ch2)

返回给定数字的十六进制表示形式的两个字符。

参数:

  • dec (int) – 要进行转换的数字。

  • ch1 (int) – 指向接收第一个十六进制字符的变量的指针。它不能为None

  • ch2 (int) – 指向接收第二个十六进制字符的变量的指针。它不能为None

注意: 返回的字符为大写形式。

wx.DirSelector

wx.DirSelector (message=DirSelectorPromptStr, default_path="", style=0, pos=DefaultPosition, parent=None)

弹出一个目录选择器对话框。

参数的含义与DirDialog.init中的参数含义相同。消息会显示在顶部,并且如果指定了 默认路径,它将被设置为初始选择的路径。

应用程序必须检查返回值是否为空(如果用户按下了“取消”按钮)。例如:

selector = wx.DirSelector("Choose a folder")
if selector.strip():
    # 对目录名称做些处理
    print selector

参数:

  • message (string) –
  • default_path (string) –
  • style (long) –
  • pos (wx.Point) –
  • parent (wx.Window) –

返回类型:

string

wx.DisableAsserts

wx.DisableAsserts()

使断言中的条件检查失效。

这与使用None处理程序调用wx.SetAssertHandler的效果相同。

2.9.0版本新增功能。

wx.DisplayDepth

wx.DisplayDepth()

返回显示器的色彩深度(值为1表示单色显示器)。

返回类型:

int

注意:不建议在新代码中使用此函数,因为它仅适用于主显示器。相反,请使用wx.Display.GetDepth来检索相应显示器的色彩深度。

wx.DisplaySize

wx.DisplaySize()

返回以像素为单位的显示器尺寸。

如果调用者对相应的值不感兴趣,那么任意一个输出指针都可以为None

返回类型:

tuple

返回:

( width, height )

注意:不建议在新代码中使用此函数,因为它仅适用于主显示器。相反,请使用 wx.Display.GetGeometry来检索相应显示器的尺寸。

另请参阅wx.GetDisplaySizewx.Display

wx.DisplaySizeMM

wx.DisplaySizeMM()

返回以毫米为单位的显示器尺寸。

如果调用者对相应的值不感兴趣,那么两个输出指针中的任意一个都可以为None

返回类型:

tuple

返回:

( width, height )

另请参阅wx.GetDisplaySizeMMwx.Display

wx.DumpWindow

wx.DumpWindow (window)

返回一个字符串,其中包含针对该窗口、便于诊断的、人类可读的、特定于平台的描述信息。

此函数返回的字符串没有任何固定形式,并且在不同的wxWidgets端口和版本之间可能会有所不同,但它包含了关于该窗口的一些有用描述,并能对其进行唯一标识。将其包含在调试或跟踪消息中可能会很有用。

参数:

window (wx.Window) – 窗口指针,允许为None

返回类型:

string

4.1版本/wxWidgets-3.1.6新增。

E

wx.EmptyBitmap

wx.EmptyBitmap (width, height, depth=BITMAP_SCREEN_DEPTH)

wx.Bitmap(width, height, depth)构造函数的一个兼容性包装器。

wx.EmptyBitmapRGBA

wx.EmptyBitmapRGBA (width, height, red=0, green=0, blue=0, alpha=0)

wx.Bitmap.FromRGBA的兼容性封装函数。

wx.EmptyIcon

wx.EmptyIcon()

Icon构造函数的兼容性封装函数。

wx.EmptyImage

wx.EmptyImage (width=0, height=0, clear=True)

wx.Image(width, height)构造函数的兼容性封装函数。

wx.EnableTopLevelWindows

wx.EnableTopLevelWindows (enable=True)

此函数用于启用或禁用所有顶级窗口。

wx.SafeYield使用了它。

参数:

enable (bool) –

wx.EndBusyCursor

wx.EndBusyCursor()

将应用程序中所有窗口的光标恢复为原来的光标。

wx.BeginBusyCursor一起使用。

另请参阅wx.IsBusywx.BusyCursor

wx.Execute

wx.Execute (command, flags=EXEC_ASYNC, callback=None, env=None)

在Unix或Windows系统中执行另一个程序。

在这个函数的重载版本中,如果flag参数包含EXEC_ASYNC标志(默认情况),控制权流程会立即返回。如果它包含EXEC_SYNC标志,当前应用程序会等待,直到另一个程序终止。

在同步执行的情况下,返回值是进程的退出代码(在函数返回时进程已终止),如果进程无法启动,返回值将为-1,如果进程成功终止,返回值通常为0。此外,在等待进程终止时,wx.Execute会调用wx.Yield。因此,默认情况下,此函数会禁用所有应用程序窗口,以避免在子进程运行时由于用户与程序的交互而可能导致的意外重入情况。如果你确定不禁用程序窗口是安全的,则可以传递EXEC_NODISABLE标志来防止这种自动禁用操作的发生。

然而,对于异步执行,返回值是进程ID,返回值为零表示命令无法执行。另外更为复杂的是,在这种情况下返回值为-1表示我们没有启动新进程,而是连接到了正在运行的进程(这种情况仅在Windows系统下使用DDE执行命令时才会发生)。特别要注意的是,仅在这种情况下,调用代码将不会收到关于进程终止的通知。

如果callback不为None,并且执行是异步的,那么当进程结束时,wx.Process.OnTerminate将会被调用。指定此参数还允许你通过调用wx.Process.Redirect来重定向正在启动的进程的标准输入和/或输出。

在Windows系统下,启动控制台进程时,其控制台默认会显示,但如果该进程的IO被重定向,控制台则会隐藏。这两种默认行为都可以被覆盖:如果指定了EXEC_HIDE_CONSOLE标志,控制台将永远不会显示。如果使用了EXEC_SHOW_CONSOLE标志,即使子进程的IO被重定向,控制台也会显示。这些标志都不会影响非控制台的Windows应用程序,在其他系统下也不会产生任何作用。

在Unix系统下,可以使用EXEC_MAKE_GROUP_LEADER标志来确保新进程成为进程组组长(如有需要,这将创建一个新会话)。调用wx.Kill并传入wx.KILL_CHILDREN将终止此进程及其所有子进程(那些已经启动了自己会话的子进程除外)。在Microsoft Windows(MSW)系统下,此标志仅可用于控制台进程,且对应于原生的CREATE_NEW_PROCESS_GROUP标志。

EXEC_NOEVENTS标志可防止在子进程运行期间处理任何事件。该标志应仅用于运行时间极短的进程,否则从用户的角度来看,应用程序窗口有可能会变得无响应。由于此标志仅在与EXEC_SYNC一起使用时才有意义,为方便起见,提供了EXEC_BLOCK,其值等于这两个标志值之和。

参数:

  • command (string) – 要执行的命令以及要传递给它的任何参数,以单个字符串的形式呈现,即“emacs file.txt” 。
  • flags (int) – 必须包含wx.EXEC_ASYNCwx.EXEC_SYNC中的一个,并且还可以包含wx.EXEC_SHOW_CONSOLEwx.EXEC_HIDE_CONSOLEwx.EXEC_MAKE_GROUP_LEADER(在任何一种情况下),或者wx.EXEC_NODISABLE以及wx.EXEC_NOEVENTSwx.EXEC_BLOCK(在wx.EXEC_SYNC的情况下,wx.EXEC_BLOCK等于wx.EXEC_NOEVENTSwx.EXEC_NODISABLE的组合)。
  • callback (wx.Process) – 一个指向wx.Process的可选指针。
  • env (ExecuteEnv) – 一个指向子进程附加参数的可选指针,例如子进程的初始工作目录和环境变量。此参数仅在wxWidgets 2.9.2及更高版本中可用。

返回类型:

long

wx.Exit

wx.Exit()

在调用wx.App.OnExit之后退出应用程序。

仅应在紧急情况下使用:通常,应在删除所有其他框架之后删除顶级框架,以此来终止应用程序。请参阅wx.CloseEventwx.App

F

wx.FFont (pointSize, family, flags=FONTFLAG_DEFAULT, faceName="", encoding=FONTENCODING_DEFAULT)

原文没有内容。

wx.FileSelector

wx.FileSelector (message, default_path="", default_filename="", default_extension="", wildcard=FileSelectorDefaultWildcardStr, flags=0, parent=None, x=DefaultCoord, y=DefaultCoord)

弹出一个文件选择器框。

在Windows系统中,这是常见的文件选择器对话框。 X系统中,这是一个具有相同功能的文件选择器框。路径和文件名是完整文件路径名中的不同组成部分。如果路径为空,则将使用当前目录。如果文件名为空,则不会提供默认文件名。通配符决定了在文件选择器中显示哪些文件,而文件扩展名则为所需的文件名提供一种类型扩展名。标志可以是wx.FD_OPENwx.FD_SAVEwx.FD_OVERWRITE_PROMPTwx.FD_FILE_MUST_EXIST的组合。

Unix版本和Windows版本都实现了通配符筛选功能。在文件名文本项中输入包含通配符(*,?)的文件名,然后单击“确定”,将只会显示与该模式匹配的文件。

通配符可以是对多种类型文件的一种说明,并且每种类型都有相应的描述,例如:

wildcard = "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"

应用程序必须检查返回值是否为空(即用户按下了“取消”按钮)。例如:

filename = wx.FileSelector("Choose a file to open")

if filename.strip():
    # 处理该文件
    print filename

# else: 用户按下取消按钮

参数:

  • message (string) –
  • default_path (string) –
  • default_filename (string) –
  • default_extension (string) –
  • wildcard (string) –
  • flags (int) –
  • parent (wx.Window) –
  • x (int) –
  • y (int) –

返回类型:

string

注意wx.FD_MULTIPLE只能与wx.FileDialog一起使用,而不能在此处使用,因为此函数仅返回单个文件名。

wx.FileSelectorEx

wx.FileSelectorEx (message=FileSelectorPromptStr, default_path="", default_filename="", indexDefaultExtension=None, wildcard=FileSelectorDefaultWildcardStr, flags=0, parent=None, x=DefaultCoord, y=DefaultCoord)

wx.FileSelector的一个扩展版本。

参数:

  • message (string) –
  • default_path (string) –
  • default_filename (string) –
  • indexDefaultExtension (int) –
  • wildcard (string) –
  • flags (int) –
  • parent (wx.Window) –
  • x (int) –
  • y (int) –

返回类型:

string

wx.FindMenuItemId

wx.FindMenuItemId (frame, menuString, itemString)

查找与给定框架的菜单栏相关联的菜单项标识符。

参数:

  • frame (wx.Frame) –
  • menuString (string) –
  • itemString (string) –

返回类型:

int

wx.FindWindowAtPoint

wx.FindWindowAtPoint (pt)

在屏幕坐标中给定的鼠标位置处找到最深层的窗口,如果找到则返回该窗口,若未找到则返回None

此函数会考虑给定位置处的子窗口,即使这些子窗口是禁用状态。不过,隐藏的子窗口会被该函数跳过。

参数:

pt (wx.Point) –

返回类型:

wx.Window

wx.FindWindowAtPointer

wx.FindWindowAtPointer()

在鼠标指针位置找到最深层的窗口,并以屏幕坐标形式返回该窗口以及当前指针的位置。

返回类型:

tuple

返回:

( wx.Windowpt )

wx.FindWindowById

wx.FindWindowById (id, parent=None)

FindWindowById(id, parent=None) .Window

在应用程序中查找具有给定ID的第一个窗口。如果parent为None,则搜索将从所有顶级框架和对话框开始;如果parent不为None,则搜索将仅限于给定的窗口层次结构。在这两种情况下,搜索都是递归进行的。

返回类型:

wx.Window

wx.FindWindowByLabel

wx.FindWindowByLabel (label, parent=None)

通过窗口的标签查找窗口。根据窗口类型的不同,标签可以是窗口标题或面板项标签。如果parentNone,则搜索将从所有顶级框架和对话框开始;如果不为None,则搜索将局限于给定的窗口层级结构。在这两种情况下,搜索都是递归进行的。

参数:

返回类型:

wx.Window

已弃用:函数已被wx.Window.FindWindowByLabel所取代。

wx.FindWindowByName

wx.FindWindowByName (name, parent=None)

通过窗口的名称(即在窗口构造函数或 Create函数调用中指定的名称)查找窗口。如果parentNone,则搜索将从所有顶级框架和对话框开始;如果parent不为None,则搜索将局限于给定的窗口层级结构。在这两种情况下,搜索都是递归进行的。

如果未找到具有该名称的窗口,则会调用wx.FindWindowByLabel

参数:

返回类型:

wx.Window

已弃用:已被wx.Window.FindWindowByName替代。

G

wx.GetAccelFromString

wx.GetAccelFromString(label)

原文无内容

wx.GetActiveWindow

wx.GetActiveWindow()

获取当前活动窗口(目前仅在Microsoft Windows 平台(MSW)和GTK平台上实现,在其他平台上始终返回None)。

返回类型:

wx.Window

wx.GetApp

wx.GetApp()

返回当前的应用程序对象。

返回类型:

wx.AppConsole

wx.GetBatteryState

wx.GetBatteryState()

返回电池状态,其值为 BATTERY_NORMAL_STATEBATTERY_LOW_STATEBATTERY_CRITICAL_STATEBATTERY_SHUTDOWN_STATEBATTERY_UNKNOWN_STATE 中的一种。

在未实现此功能的平台上(目前除了微软Windows系统外的所有平台),BATTERY_UNKNOWN_STATE 也是默认的电池状态。

返回类型:

wx.BatteryState

wx.GetClientDisplayRect

wx.GetClientDisplayRect()

获取显示器上工作区域的尺寸。

在Windows系统上,这意味着不被任务栏等覆盖的区域。目前在其他平台上,在找到一种能为所有窗口管理器等提供此信息的方法之前,默认将整个显示器视为工作区域。

返回类型:

wx.Rect

另请参阅:wx.Display

wx.GetColourFromUser

wx.GetColourFromUser(parent, colInit, caption="" , data=None)

显示颜色选择对话框,并返回用户选择的颜色;如果对话框被取消,则返回无效颜色(可使用 wx.Colour.IsOk来测试一个颜色是否有效)。

参数:

  • parent (wx.Window) – 颜色选择对话框的父窗口。
  • colInit (wx.Colour) – 如果提供了(颜色),这将是对话框中最初选中的颜色。
  • caption (string) – 如果提供了(内容),这将用作对话框的标题。
  • data (wx.ColourData) – 可选的对象,用于存储额外的颜色对话框设置,例如自定义颜色。如果未提供该对象,则会使用与上一次相同的设置。

返回类型:

wx.Colour

wx.GetCpuArchitectureName

wx.GetCpuArchitectureName()

返回CPU架构名称。

例如,可能是 “x86_64”、“arm64” 或 “i86pc”。在相同硬件上运行的同一CPU,其名称在不同操作系统中可能会有所不同。

如果无法识别CPU架构,返回的字符串可能为空。

返回类型:

string

4.1版本/wxWidgets-3.1.5新增。

另请参阅 wx.GetNativeCpuArchitectureName

wx.GetDisplayPPI

wx.GetDisplayPPI()

返回以每英寸像素数为单位的显示分辨率。

返回的wx.Size对象的x分量包含水平分辨率,而y分量则包含垂直分辨率。

返回类型:

wx.Size

2.9.0版本新增。

注意:不建议在新代码中使用此函数,因为它仅适用于主显示器。请改用wx.Display.GetPPI来检索相应显示器的分辨率。

另请参阅wx.Display

wx.GetDisplaySize

wx.GetDisplaySize()

返回以像素为单位的显示器尺寸。

返回类型:

wx.Size

注意:不建议在新代码中使用此函数,因为它仅对主显示器有效。请改用wx.Display.GetGeometry来获取相应显示器的尺寸。

另请参阅wx.Display

wx.GetDisplaySizeMM

wx.GetDisplaySizeMM()

返回以毫米为单位的显示器尺寸。

返回类型:

wx.Size

另请参阅wx.Display

wx.GetEmailAddress

wx.GetEmailAddress()

通过将wx.GetFullHostNamewx.GetUserId返回的值进行拼接,将用户的电子邮件地址复制到提供的缓冲区中。

返回类型:

string

返回:

若获取成功,则返回True,否则返回 False

wx.GetFontFromUser

wx.GetFontFromUser(parent, fontInit, caption="" )

显示字体选择对话框,并返回用户选择的字体;如果对话框被取消,则返回无效字体(使用wx.Font.IsOk来测试字体是否有效)。

参数:

  • parent (wx.Window) – 字体选择对话框的父窗口。
  • fontInit (wx.Font) – 如果提供了(字体),这将是对话框中最初选中的字体。
  • caption (string) – 如果提供了(内容),这将被用作对话框的标题。

返回类型:

wx.Font

wx.GetFullHostName

wx.GetFullHostName()

返回完全限定域名(FQDN,fully qualified domain host name),如果出错则返回空字符串。

返回类型:

string

另请参阅wx.GetHostName

wx.GetHomeDir

wx.GetHomeDir()

返回(当前)用户的主目录。

返回类型:

string

另请参阅:wx.GetUserHomewx.StandardPaths

wx.GetHostName

wx.GetHostName()

将当前主机的名称存储到所提供的缓冲区中。

请注意,返回的名称并完全限定名称,也就是说,它不包含域名。

返回类型:

string

返回:

如果成功则返回主机名,否则返回空字符串。

另请参阅wx.GetFullHostName

wx.GetKeyState

wx.GetKeyState(key)

对于普通按键,如果指定的按键当前处于按下状态,则返回True

对于可切换的按键(大写锁定键(Caps Lock)、数字锁定键(Num Lock)和滚动锁定键(Scroll Lock)),如果该按键处于切换状态使得其指示灯亮起,则返回True。目前没有办法测试可切换按键是处于抬起还是按下状态。

尽管为鼠标按键定义了虚拟键码,但目前此函数不能用于鼠标按键。

在wxGTK中,当目前不使用X11后端时,此函数只能用于修饰键(WXK_ALTWXK_CONTROLWXK_SHIFT)。

参数:

key (KeyCode) –

返回类型:

bool

wx.GetLibraryVersionInfo

wx.GetLibraryVersionInfo()

获取wxWidgets版本信息。

返回类型:

wx.VersionInfo

2.9.2版本新增。

另请参阅: wx.VersionInfo

wx.GetLocale

wx.GetLocale()

获取当前的区域设置对象(请注意,可能为None!)

返回类型:

wx.Locale

wx.GetMousePosition

wx.GetMousePosition()

返回鼠标在屏幕坐标中的位置。

返回类型:

wx.Point

wx.GetMouseState

wx.GetMouseState()

返回鼠标的当前状态。

返回一个wx.MouseState实例,该实例包含鼠标指针在屏幕坐标中的当前位置,以及表示鼠标按键和修饰键按下/弹起状态的布尔值。

返回类型:

wx.MouseState

wx.GetNativeCpuArchitectureName

wx.GetNativeCpuArchitectureName()

在某些情况下,当前进程的CPU架构和本机的CPU架构可能会有所不同。

此操作会返回本机的CPU架构,而与当前进程的CPU架构无关。

CPU架构存在差异的常见例子如下:

  • 在64位Windows系统(WoW环境)中的32位Windows进程
  • ARM64架构的Windows系统(WoW64环境)上的32位Windows进程或64位Windows进程
  • ARM64架构的macOS系统(通过Rosetta 2转译)上的x86_64架构进程

如果无法识别CPU架构,返回的字符串可能为空。

返回类型:

string

4.1版本/wxWidgets-3.1.6新增。

另请参阅:wx.GetCpuArchitectureName

wx.GetNumberFromUser

wx.GetNumberFromUser(message, prompt, caption, value, min=0, max=100, parent=None, pos=DefaultPosition)

显示一个对话框,要求用户输入数字。

对话框的标题设置为caption,它在单行提示上方包含一条(可能是)多行消息,以及用于输入数字的区域。

输入的数字必须在minmax的范围内(这两个值都应为正数),value是其初始值。如果用户输入了无效值,该值将被强制调整到指定范围内。如果用户取消了对话框,该函数将返回-1。如果区分取消对话框和实际在对话框中输入-1很重要,也就是说,如果-1是一个有效的输入值,那么就不能使用这个便捷函数,而应该直接使用wx.NumberEntryDialog

除非在pos中指定了明确的位置,否则对话框将在其父窗口的中心位置显示。

参数:

  • message (string) –
  • prompt (string) –
  • caption (string) –
  • value (long) –
  • min (long) –
  • max (long) –
  • parent (wx.Window) –
  • pos (wx.Point) –

返回类型:

long

另请参阅wx.NumberEntryDialog

wx.GetOsDescription

wx.GetOsDescription()

以用户可读的形式返回包含当前平台描述的字符串。

例如,此函数可能会返回诸如“Windows 10(内部版本 10240),64 位版本”或“Linux 4.1.4 i386”这样的字符串。

返回类型:

string

另请参阅wx.GetOsVersion

wx.GetOsVersion

wx.GetOsVersion(micro=None)

获取当前正在运行的操作系统的版本和操作系统ID

返回的OperatingSystemId值可用于对操作系统家族进行基本分类;主版本号、次版本号和修订版本号有助于检测特定的系统。

如果在类Unix系统上无法检测到版本,则这三个版本号的值都将为-1。

在仅无法检测到修订版本号或修订版本号没有意义的系统上,该值将为0。

对于类Unix系统(OS_UNIX),主版本号、次版本号和修订版本号整数将包含内核的主版本号、次版本号和修订版本号(如“uname -r”命令返回的值);例如,如果机器使用的是内核4.1.4,则为“4”、“1”和“4”。

对于macOS系统(OS_MAC),主版本号和次版本号整数是与操作系统相关的实际版本号;例如,如果机器使用的是macOS El Capitan 10.11.2,则为“10”、“11”和“2”。

对于类Windows系统(OS_WINDOWS),主版本号、次版本号和修订版本号(等于内部版本号)整数将包含以下值:

有关上述值的更多信息,请参阅Microsoft文档

参数:

micro (int) –

返回类型:

tuple

返回:

( wx.OperatingSystemId, major, minor )

另请参阅wx.GetOsDescription , PlatformInfo

wx.GetPasswordFromUser

wx.GetPasswordFromUser(message, caption=GetPasswordFromUserPromptStr, default_value="" , parent=None, x=DefaultCoord, y=DefaultCoord, centre=True)

wx.GetTextFromUser类似,但在对话框中输入的文本不会显示在屏幕上,而是会被星号替代。

正如函数名所暗示的那样,该功能旨在用于输入密码。

参数:

  • message (string) –
  • caption (string) –
  • default_value (string) –
  • parent (wx.Window) –
  • x (int) –
  • y (int) –
  • centre (bool) –

返回类型:

string

wx.GetPowerType

wx.GetPowerType()

返回电源的类型,其值为POWER_SOCKET , POWER_BATTERYPOWER_UNKNOWN之一。

在未实现此功能的平台上(目前除了微软Windows系统外的所有平台),默认返回值也是POWER_UNKNOWN

返回类型:

wx.PowerType

wx.GetProcessId

wx.GetProcessId()

返回在系统中唯一标识当前进程的数字。

如果发生错误,则返回0。

返回类型:

int

wx.GetSingleChoice

wx.GetSingleChoice *(*args, *kw)

重载的实现方式:


GetSingleChoice (message, caption, aChoices, parent=None, x=DefaultCoord, y=DefaultCoord, centre=True, width=CHOICE_WIDTH, height=CHOICE_HEIGHT, initialSelection=0)

弹出一个对话框,其中包含一条消息、“确定”/“取消”按钮以及一个单选列表框。

用户可以选择一个项目,然后按下“确定”(wx.OK)按钮以返回一个字符串,或者按下“取消”按钮以返回空字符串。如果空字符串是一个有效的选择,并且你希望能够可靠地检测到按下“取消”按钮的情况,则可以使用wx.GetSingleChoiceIndex函数。

你可以通过choices来传递可供选择的字符串列表,choices是一个包含n个字符串的数组,用于填充列表框;或者使用一个类型为字符串列表的单个aChoices参数来传递。

如果centreTrue,则消息文本(其中可能包含换行符)将居中显示;如果为False,则消息将左对齐显示。


GetSingleChoice (message, caption, choices, initialSelection, parent=None)

参数:

  • message (string) –
  • caption (string) –
  • choices (list of strings) –
  • initialSelection (int) –
  • parent (wx.Window) –

返回类型:

string


wx.GetStockLabel(id, flags=STOCK_WITH_MNEMONIC)

返回应用于给定ID元素的标签。

参数:

返回类型:

string

wx.GetTextFromUser(message, caption=GetTextFromUserPromptStr, default_value="" , parent=None, x=DefaultCoord, y=DefaultCoord, centre=True)

弹出一个对话框,将其标题设置为caption,显示message,并带有一个default_value

用户可以输入文本,然后按下wx.OK按钮以返回输入的文本,或者按下“取消”按钮以返回空字符串。

如果centreTrue,则消息文本(其中可能包含换行符)将居中显示;如果为False,则消息将左对齐显示。

此函数是wx.TextEntryDialog的一个包装函数。虽然通常使用这个函数更方便,但直接使用该对话框会更灵活。例如,直接使用对话框允许你指定TE_MULTILINE以便用户输入多行文本,而此函数仅局限于单行输入。

参数:

  • message (string) –
  • caption (string) –
  • default_value (string) –
  • parent (wx.Window) –
  • x (int) –
  • y (int) –
  • centre (bool) –

返回类型

string

wx.GetTopLevelParent (window)

返回给定窗口的第一个顶级父窗口,也就是说,返回包含该窗口的框架或对话框,或者返回None

请注意,如果该窗口本身已经是一个顶级窗口(TLW),则会直接返回该窗口本身。

参数:

window (wx.Window) –

返回类型:

wx.Window

wx.GetTopLevelWindows

wx.GetTopLevelWindows()

返回一个类似列表的对象,其中包含应用程序的顶级窗口(frame、对话框等)。

返回类型:

WindowList

wx.GetTranslation

wx.GetTranslation( *args, **kw)

重载的实现方式:


GetTranslation (string, domain=””, context=””)

此函数返回字符串在当前locale()下的翻译内容。

如果在任何已加载的消息目录中(请参阅“国际化”相关内容)都未找到该字符串,则返回原始字符串。如果使用“i18n”掩码启用了跟踪消息的日志记录(通过wx.Log.AddTraceMask方法),并且启用了调试日志记录(请参阅“调试”相关内容),在这种情况下还会记录一条消息,这有助于查找尚未翻译的字符串。

如果指定了domain,则仅在该域/目录中搜索匹配的字符串。由于此函数使用非常频繁,因此提供了一种替代语法(在Unix环境中也很常见):定义的wx._宏与wx.GetTranslation的功能相同。

如果context不为空(请注意,此参数从wxWidgets 3.1.1版本开始才可用),则会在指定的上下文中查找项目翻译。这允许对出现在不同上下文中的相同字符串进行不同的翻译,例如,根据“Open”(打开)这个英文动词所适用的对象不同,可能需要对其进行不同的翻译。要实现这一点,你需要在源消息目录中使用msgctxt,并为字符串的不同出现情况指定不同的上下文,然后在调用此函数(或GETTEXT_IN_CONTEXTGETTEXT_IN_CONTEXT_PLURAL宏)时使用相同的上下文。

此函数是线程安全的。

参数:

  • string (string) –
  • domain (string) –
  • context (string) –

返回类型:

string

注意:此函数不适用于使用T宏的字面字符串,因为xgettext无法识别此宏,所以这类字符串不会被提取到消息目录中。相反,对于所有字面字符串,请使用wx._宏和PLURAL宏。

另请参阅: GetTranslation(const String&, String&, unsigned, String&)

GetTranslation (string, plural, n, domain=””, context=””) 这是GetTranslation(const String&, String&)的一个重载版本,有关一般信息,请参阅其文档。当检索在英语中有不同单复数形式,或在其他某些语言中有不同复数形式的字符串的翻译时,会使用此版本。与GetTranslation(const String&,const String&)一样,string参数必须包含要转换的字符串的单数形式,并用作在目录中搜索的键。plural参数是(英语中的)复数形式。参数n用于确定复数形式。如果未找到消息目录,当 “n == 1” 时返回string,否则返回plural。 有关复数形式处理的更多信息,请参阅GNU gettext手册:www.gnu.org/software/ge…。 有关更简短的替代方式,请参阅PLURAL宏。 此函数是线程安全的。

参数

  • string (string) –
  • plural (string) –
  • n
  • domain (string) –
  • context (string) –

返回类型:

string

wx.GetUserHome

wx.GetUserHome(user="" )

返回给定用户的主目录。

如果用户为空(默认值),此函数的行为与wx.GetHomeDir类似(即返回当前用户的主目录)。

如果无法确定主目录,则返回一个空字符串。

参数:

user (string) –

返回类型:

string

wx.GetUserId

wx.GetUserId()

此函数返回“用户ID”,在Unix系统下也称为“登录名”(即类似“jsmith”这样的名称)。它唯一标识了(在本系统上的)当前用户。在Windows或NT系统下,此函数首先会在环境变量USERLOGNAME中查找;如果这两个变量都未找到,则会尝试读取WIN.INI文件中wxWidgets部分的UserId项。

返回类型:

string

返回:

如果成功则返回登录名,否则返回空字符串。

另请参阅wx.GetUserName

wx.GetUserName

wx.GetUserName()

此函数返回完整的用户名(类似于“Mr. John Smith”这样的名称)。

在Windows或NT系统下,此函数会在WIN.INI文件中wxWidgets部分查找UserName项。如果PenWindows正在运行,则会使用PENWIN.INI文件中User部分的Current项。

返回类型:

string

返回:

如果成功则返回完整的用户名,否则返回空字符串。

另请参阅wx.GetUserId

H

wx.HandleFatalExceptions

wx.HandleFatalExceptions(doIt=True)

如果doIttrue,则致命异常(在Windows下也称为一般保护错误,在Unix环境中称为段错误)将被捕获,并传递给wx.App.OnFatalException

默认情况下,即在调用此函数之前,这些致命异常将以常规方式处理,这通常意味着应用程序将会终止。调用wx.HandleFatalExceptions并将doIt设置为false将恢复这种默认行为。

请注意,只有当USE_ON_FATAL_EXCEPTION为1时,此函数才可用。并且在Windows平台上,这要求编译器支持结构化异常处理(SEH),目前这意味着只有Microsoft Visual C++编译器支持。

参数:

doIt (bool) –

返回类型:

bool

wx.HelpController

wx.HelpController(parentWindow=None)

Python版本的HelpController并非是某个类的别名,而是一个工厂函数,它会创建并返回适合该平台的最佳帮助控制器的一个实例。

wx.HexToDec

wx.HexToDec( *args, **kw)

重载实现:


HexToDec (buf)

将两位十六进制字符串转换为十进制整数。

参数:

buf (string) – 包含大写十六进制字符的字符串,且前面没有0x前缀。其长度必须至少为两个字符。如果长度超过两个字符,只有前两个字符会被转换为数字。

返回类型:

int

返回:

一个介于0到255之间且与buf中的数字等效的整数,如果buf不是十六进制字符串,则返回-1


HexToDec (buf)

这是一个重载的成员函数,为了方便而提供。它与上述函数的区别仅在于所接受的参数不同。

参数:

buf (int) –

返回类型:

int


I

wx.ImageFromBitmap

wx.ImageFromBitmap(bitmap)

wx.Bitmap创建Image

wx.ImageFromBuffer

wx.ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None)

根据dataBuffer中的数据创建一个ImagedataBuffer参数必须是一个实现了缓冲区接口的Python对象,例如字符串、数组等。预计dataBuffer对象包含一系列RGB字节,且长度为widthheight3字节。可以选择为图像的alpha通道数据提供一个缓冲区对象,预计其长度为width*height字节。

创建Image时,其数据指针和alpha指针将初始化为指向缓冲区对象所指向的内存地址,这样就节省了将图像数据从缓冲区对象复制到Image所需的时间。虽然这有一定优势,但也存在在两个对象之间共享C指针而可能导致自食恶果的风险。

为了帮助降低这种风险,会保留对Image所使用的数据和alpha缓冲区对象的引用,这样在wx.Image被删除之前,这些缓冲区对象不会被删除。然而请注意,不能保证一个对象在需要调整其内容大小时不会将其内存缓冲区移动到新的位置。如果发生这种情况,那么Image最终将引用一个无效的内存位置,可能会导致应用程序崩溃。因此,应该注意不要以会导致数据和alpha缓冲区所使用的对象改变大小的方式来操作这些对象。

wx.ImageFromData

wx.ImageFromData(width, height, data)

用于从RGB数据创建图像的兼容性包装器。

wx.ImageFromDataWithAlpha

wx.ImageFromDataWithAlpha(width, height, data, alpha)

用于从RGB和透明度(Alpha)数据创建图像的兼容性包装器。

wx.ImageFromStream

wx.ImageFromStream(stream, type=BITMAP_TYPE_ANY, index=-1)

从一个流(类似文件的对象)中加载一幅图像。

wx.InfoMessageBox

wx.InfoMessageBox(parent)

显示一个消息框,其中包含所使用的wxWidgets构建的相关信息,包括其版本、最重要的构建参数以及GUI工具包的版本。

这主要用于诊断目的,并且可以通过在任何原本不处理此事件的wx.Window上同时按下Ctrl、Alt 和鼠标中键来调用。

参数:

parent (wx.Window) –

2.9.0版本新增。

另请参阅wx.GetLibraryVersionInfo

wx.InitAllImageHandlers

wx.InitAllImageHandlers()

初始化所有可用的图像处理器。

此函数会针对所有可用的图像处理器调用wx.Image.AddHandler(完整列表请参阅“可用的图像处理器”)。调用该函数是初始化wx.Image最简单的方式,但它会创建并注册即使你的程序可能不会用到的处理器。如果你想避免这样做带来的开销,你需要仅针对你确实想要使用的处理器手动调用wx.Image.AddHandler

另请参阅wx.Imagewx.ImageHandler

wx.IntersectRect

wx.IntersectRect(r1, r2)

计算并返回r1和r2的交集。如果不存在交集,则返回None。

返回类型:

PyObject

wx.IsBusy

wx.IsBusy()

如果处于wx.BeginBusyCursor调用和wx.EndBusyCursor调用之间,则返回True

返回类型:

bool

另请参阅wx.BusyCursor

wx.IsDragResultOk

wx.IsDragResultOk(res)

如果res表明在一次拖放(DnD)操作期间有某些操作被执行了,也就是说res既不是表示错误,也不是表示无操作,也不是表示已取消,那么就返回True

参数:

res (DragResult) –

返回类型:

bool

wx.IsMainThread

wx.IsMainThread()

如果当前线程被视为GUI线程,则返回True

返回类型:

bool

wx.IsPlatform64Bit

wx.IsPlatform64Bit()

如果程序正在运行的操作系统是64位的,则返回True

此检查是在运行时执行的,可能与编译时可用的值不同(在编译时,你只需检查sizeof(void*) == 8即可),因为程序可能在仿真模式下运行,或者是在一个32位/64位混合的系统中运行。

返回类型:

bool

注意 鉴于并非总是存在一种标准方法来可靠地检查操作系统的位数,因此在某些系统上,这个函数并非100%可靠。

wx.IsPlatformLittleEndian

wx.IsPlatformLittleEndian()

如果当前平台是小端序(而非大端序),则返回True

此检查是在运行时执行的。

返回类型:

bool

另请参阅: 字节序函数和宏

wx.IsRunningUnderWine

wx.IsRunningUnderWine()

仅当在Wine环境下运行Microsoft Windows(MSW)程序时才返回True

这个函数可用于检查在使用Wine时某些未实现的功能。

返回类型:

bool

4.1版本/wxWidgets-3.1.6新增。

K

wx.Kill

wx.Kill(pid, sig=SIGTERM, rc=None, flags=KILL_NOCHILDREN)

等同于Unix系统中的kill函数:将给定的信号sig发送给进程ID为PID的进程。

有效的信号值如下:

# 信号值枚举

wx.SIGNONE  # 在Unix系统下验证该进程是否存在
wx.SIGHUP
wx.SIGINT
wx.SIGQUIT
wx.SIGILL
wx.SIGTRAP
wx.SIGABRT
wx.SIGEMT
wx.SIGFPE
wx.SIGKILL  # 危险,强制杀死!
wx.SIGBUS
wx.SIGSEGV
wx.SIGSYS
wx.SIGPIPE
wx.SIGALRM
wx.SIGTERM  # 温和地终止进程

  SIGNONE、SIGKILL以及SIGTERM在Unix系统和Windows系统下含义相同,但在Windows系统下,
所有其他信号都等同于SIGTERM。此外,在Windows系统下,SIGTERM是通过向应用程序窗口发送
一条消息来实现的,所以只有当应用程序确实有窗口时它才起作用。如果应用程序没有窗口,就像
控制台应用程序通常的情况那样,你需要使用SIGKILL来真正终止该进程。当然,这并不允许进程
正常关闭,所以如果可能的话应该避免使用这种方式。 

成功时返回0,失败时返回-1。如果rc参数不为None,它将被填充为KillError枚举中的一个值。

# KillError枚举

wx.KILL_OK             # 没有错误
wx.KILL_BAD_SIGNAL     # 没有这样的信号
wx.KILL_ACCESS_DENIED  # 没有权限
wx.KILL_NO_PROCESS     # 没有这样的进场
wx.KILL_ERROR          # 未指明的错误

flags参数可以是wx.KILL_NOCHILDREN(默认值),或者wx.KILL_CHILDREN,在使用wx.KILL_CHILDREN的情况下,该进程的子进程也将被终止。请注意,在Unix系统下,要使wx.KILL_CHILDREN起作用,你应该在调用wx.Execute时通过传递wx.EXEC_MAKE_GROUP_LEADER来创建进程。

参数:

返回类型:

int

另请参阅wx.Process.Killwx.Process.Exists,外部程序执行示例

L

wx.LaunchDefaultApplication

wx.LaunchDefaultBrowser(url, flags=0)

在用户的默认浏览器中打开该url

如果flags参数包含BROWSER_NEW_WINDOW标志,则会为该网址打开一个新窗口(目前这仅在 Windows 系统下受支持)。

并且,除非flags参数包含BROWSER_NOBUSYCURSOR标志,否则在浏览器启动期间会显示忙碌光标(使用wx.BusyCursor)。

参数url的解释如下:

  • 如果它有一个有效的协议(例如“file:”“http:”“mailto:”),它将被传递给用户系统中配置的相应浏览器。
  • 如果它没有有效的协议(例如,它是一个没有“file:”前缀的本地文件路径),那么将使用FileExistsDirExists来测试它是否为本地文件/目录;如果是,那么最终会在url参数前加上“file:”后调用浏览器。
  • 如果它没有有效的协议,并且它不是本地文件/目录,那么会在其前面加上“http:”,然后调用浏览器。

如果应用程序成功启动,则返回值为True

参数:

  • url (string) –
  • flags (int) –

返回类型:

bool

注意:对于正在运行的用户的某些配置情况,被启动以打开给定网址的应用程序可能会因网址而异(例如,对于本地网址可能会使用一个浏览器,而对于远程网址可能会使用另一个浏览器)。

另请参阅wx.LaunchDefaultApplicationwx.Execute

wx.LoadFileSelector

wx.LoadFileSelector(what, extension, default_name="" , parent=None)

显示一个文件对话框,询问用户用于打开文件的文件名。

参数:

  • what (string) –
  • extension (string) –
  • default_name (string) –
  • parent (wx.Window) –

返回类型:

string

另请参阅wx.FileSelectorwx.FileDialog

wx.LogDebug

wx.LogDebug(message)

用于输出调试的函数。

仅在调试模式下(当预处理器符号__WXDEBUG__被定义时)执行某些操作,而在发布模式下(在其他情况下)则不执行任何操作(即展开为空)。

参数:

message (String) –

wx.LogError

wx.LogError(message)

用于显示错误消息的函数,也就是说,这些是必须展示给用户的消息。默认的处理方式是弹出一个消息框来告知用户相关情况。

参数:

message (String) –

wx.LogFatalError

wx.LogFatalError(message)

类似于wx.LogError,但同时会使用退出码3来终止程序。

使用标准函数abort() 也会以这个退出码来终止程序。

参数:

message (String) –

wx.LogGeneric

wx.LogGeneric(level, message)

使用给定的日志级别记录一条消息。

例如,将LOG_Message作为第一个参数时,此函数的行为类似于wx.LogMessage

参数:

  • level (wx.LogLevel) –
  • message (String) –

wx.LogInfo

wx.LogInfo(formatString)

用于低优先级的消息。

这些消息在默认的日志记录器中,其处理方式与wx.LogMessage记录的消息相同,但自定义的日志记录器可能会以不同的方式来处理它们。

参数:

  • formatString (int) –
  • ``

wx.LogMessage

wx.LogMessage(message)

用于所有常规的、提供信息的消息。

默认情况下,这些消息也会显示在一个消息框中(不过这是可以更改的)。

参数:

message (String) –

wx.LogStatus

wx.LogStatus( *args, **kw)

重载实现:


LogStatus (frame, message)

默认情况下,由该函数记录的消息将显示在frame或顶级应用程序窗口的状态栏中(即, 当使用该函数的第二个版本时)。

如果目标框架没有状态栏,那么该消息将会丢失。

参数:

  • frame (wx.Frame) –
  • message (String) –

LogStatus (message)

参数:

message (String) –

wx.LogSysError

wx.LogSysError(message)

大多由wxWidgets自身使用,但在系统调用(API函数)失败后用于记录错误时可能也很有用。

它会记录指定的消息文本,以及最后一个系统错误代码(根据平台不同,可能是errnoGetLastError() )和相应的错误消息。该函数的第二种形式会明确地将错误代码作为第一个参数。

参数:

message (String) –

另请参阅wx.SysErrorCodewx.SysErrorMsgStr

wx.LogVerbose

wx.LogVerbose(message)

用于详细输出。

默认情况下,由这些函数生成的消息会被抑制,即使日志级别高于wx.LOG_Info也是如此,并且需要通过调用wx.Log.SetVerbose来显式激活。

请注意,除非覆盖了标准命令行处理,否则如果在程序命令行中指定了--verbose选项wxWidgets会自动执行此操作。因此,使用这些函数提供了一种简单的方式,使得一些诊断消息默认不显示,但用户在需要时可以轻松地让它们显示出来。

参数:

message (String) –

wx.LogWarning

wx.LogWarning(message)

对于警告信息——它们通常也会显示给用户,但不会中断程序的运行。

参数:

message (String) –

M

wx.MacThemeColour

MacThemeColour(themeBrushID)

返回类型:

wx.Colour

wx.MessageBox

wx.MessageBox(message, caption=MessageBoxCaptionStr, style=OK|CENTRE, parent=None, x=DefaultCoord, y=DefaultCoord)

显示一个通用的消息对话框。

这是一个方便的函数,通常用来替代直接使用wx.MessageDialog。不过要注意,一些特性,比如扩展文本以及消息框按钮的自定义标签,这个函数并不提供,只有wx.MessageDialog才具备这些特性。

返回值为以下之一:YESNOCANCELOKHELP(请注意,此返回值与 wx.MessageDialog.ShowModal的返回值不同)。

例如:

answer = wx.MessageBox("Quit program?", "Confirm",
                       wx.YES_NO | wx.CANCEL, main_frame)
if answer == wx.YES:
    main_frame.Close()

消息中可能包含换行符,在这种情况下,消息将被拆分成单独的行,以适应较长的消息内容。

参数:

  • message (string) – 要在对话框中显示的消息。
  • caption (string) – 对话框的标题。
  • style (int) – wx.MessageDialog文档中所描述的样式标志的组合。
  • parent (wx.Window) – 父级窗口.
  • x (int) – 对话框的水平位置(在Microsoft Windows平台下被忽略)。对于xy坐标,使用wx.DefaultCoord可让系统来定位窗口。
  • y (int) – 对话框的垂直位置(在Microsoft Windows平台下被忽略)。

返回类型:

int

wx.MicroSleep

wx.MicroSleep(microseconds)

睡眠指定的微秒数。

实际上,并非所有平台都能实现微秒级别的时间精度(目前只有支持nanosleep(2)函数的Unix平台可能提供这种精度),在这种情况下,该函数的效果与调用wx.MilliSleep 函数并传入参数为“微秒数除以1000”时是一样的。

参数:

microseconds (long) –

wx.MilliSleep

wx.MilliSleep(milliseconds)

睡眠指定的毫秒数。

请注意,建议使用此函数,而不要直接调用usleep(3),因为标准的usleep() 函数不是线程安全的。

参数:

milliseconds (long) –

N

wx.NewEventType

wx.NewEventType()

生成一个新的唯一事件类型。

通常这个函数仅由DEFINE_EVENT使用,而不会被直接调用。

返回类型:

wx.EventType

wx.NewId

wx.NewId()

生成一个在程序本次运行中唯一的整数标识符。

返回类型:

wx.WindowID

已弃用:由该函数生成的标识符有可能与应用程序代码中其他地方使用的标识符发生冲突。建议使用 wx.ID_ANY标识符来为你在应用程序中创建的控件、菜单项等分配生成的标识符。这些标识符能保证不会与应用程序中正在使用的其他标识符产生冲突。对于那些你需要创建可多次使用的标识符的情况,请查看wx.NewIdRef

另请参阅:wx.RegisterId

wx.NewIdRef

wx.NewIdRef(count=1)

保留一个新的窗口标识符(或窗口标识符范围),并返回一个wx.WindowIDRef对象(或对象列表),该对象将有助于管理该标识符的保留情况。

此函数旨在直接替代旧的且已弃用的wx.NewId函数,其额外的好处是生成的标识符绝不应与正在使用的标识符或此函数生成的其他标识符发生冲突。

wx.Now

wx.Now()

返回一个表示当前日期和时间的字符串。

返回类型:

string

P

wx.PostEvent

wx.PostEvent(dest, event)

在GUI应用程序中,此函数会使用wx.EvtHandler.AddPendingEvent向指定的目标对象投递事件。

否则,它会使用wx.EvtHandler.ProcessEvent立即派发事件。有关详细信息(以及注意事项),请参阅相应的文档。由于wx.EvtHandler.AddPendingEvent的限制,对于具有字符串字段的事件对象,此函数不是线程安全的,此时应使用wx.QueueEvent函数。

参数:

wx.pydate2wxdate

wx.pydate2wxdate(date)

将Python的date或datetim 对象转换为一个DateTime对象。

Q

wx.QueueEvent

wx.QueueEvent(dest, event)

将一个事件排入队列,以便在给定对象上进行处理。

这是对wx.EvtHandler.QueueEvent的封装,更多详细信息请参阅其文档。

参数:

  • dest (wx.EvtHandler) – 要将事件排入其队列的对象,不能为NULL
  • event (wx.Event) – 要排入队列的堆分配且不为NULL的事件,该函数将获得其所有权。

R

wx.RegisterId

wx.RegisterId(id)

确保随后由wx.NewId生成的标识符不会与给定的标识符发生冲突。

参数:

id (wx.WindowID) –

S

wx.SafeShowMessage

wx.SafeShowMessage(title, text)

此函数以安全的方式向用户显示一条消息,即使在应用程序尚未初始化之前,或者当应用程序当前处于某种其他异常状态(例如即将崩溃)时,调用该函数也是安全的。

在Windows系统下,此函数会使用原生对话框来显示消息框,而不是使用wx.MessageBox (调用 其可能不安全);在其他系统环境中,它只是简单地将消息以标题作为前缀打印到标准输出中。

参数:

  • title (string) – 显示给用户的消息框的标题,或者消息字符串的前缀。
  • text (string) – 要展示给用户的文本。

返回类型:

bool

返回:

如果实际显示了消息框,则返回True;如果由于当前没有安全的方式来显示消息而将消息记录到控制台,则返回False(返回值仅在wxWidgets 3.1.5及更高版本中可用,在之前的版本中该函数不返回任何内容)。

另请参阅wx.LogFatalError

wx.SafeYield

wx.SafeYield(win=None, onlyIfNeeded=False)

调用wx.App.SafeYield

参数:

  • win (wx.Window) –
  • onlyIfNeeded (bool) –

返回类型:

bool

wx.SaveFileSelector

wx.SaveFileSelector(what, extension, default_name="" , parent=None)

显示一个文件对话框,询问用户用于保存文件的文件名。

参数:

  • what (string) –
  • extension (string) –
  • default_name (string) –
  • parent (wx.Window) –

返回类型:

string

另请参阅wx.FileSelectorwx.FileDialog

wx.SecureZeroMemory

wx.SecureZeroMemory(p, n)

以一种能确保不会被编译器优化掉的方式,用零填充内存块。

参数:

  • p – 指向要清零的内存块的指针,不能为None
  • n (int) – 要清零的字节数。

4.1版本/wxWidgets-3.1.6新增。

wx.SetCursor

wx.SetCursor(cursor)

全局设置光标;仅在Windows、Ma和GTK+系统上有效。

你应该使用NullCursor调用此函数来恢复系统光标。

参数:

cursor (wx.Cursor) –

另请参阅wx.Cursorwx.Window.SetCursor

wx.Shell

wx.Shell(command="" )

在交互式shell窗口中执行一条命令。

如果未指定命令,那么仅会启动shell。

参数:

command (string) –

返回类型:

bool

另请参阅wx.Execute,外部程序执行示例

wx.Shutdown

wx.Shutdown(flags=SHUTDOWN_POWEROFF)

此函数会根据flags的值来关闭或重启计算机。

参数:

flags (int) – 可以是SHUTDOWN_POWEROFFSHUTDOWN_REBOOTSHUTDOWN_LOGOFF(目前仅在 Microsoft Windows 平台上实现) 中的一个,可能还会与SHUTDOWN_FORCE结合使用,在Microsoft Windows平台上,SHUTDOWN_FORCE会通过强制终止所有应用程序来强制关机。由于这样做可能会导致数据丢失,所以除非确实有必要,否则不应使用该标志。

返回类型:

bool

返回:

如果成功返回True,如果发生错误返回False

注意:请注意,执行关机操作需要相应的访问权限(在Unix系统下需要超级用户权限,在Windows 统下需要SE_SHUTDOWN特权),并且此函数仅在Unix系统和Microsoft Windows系统下实现。

wx.Sleep

wx.Sleep(secs)

睡眠指定的秒数。

参数:

secs (int) –

wx.StripMenuCodes

wx.StripMenuCodes(str, flags=Strip_All)

从字符串str中去除所有菜单代码并返回结果。

默认情况下,该函数会去除用于表示键盘快捷键的助记符字符(“&”)以及仅在菜单项中使用且通过 \t制表符)字符与正文文本分隔开的加速键。可以分别使用Strip_MnemonicsStrip_Accelflags来仅去除前者或后者部分。

请注意,在大多数情况下,可以改用wx.MenuItem.GetLabelFromTextwx.Control.GetLabelText

参数:

  • str (string) –
  • flags (int) –

返回类型:

string

wx.SysErrorCode

wx.SysErrorCode()

返回来自上一次系统调用的错误码。

此函数在Unix平台上使用errno,在Win32环境下使用GetLastError

返回类型:

int

另请参阅wx.SysErrorMsgStr , wx.LogSysError

wx.SysErrorMsg

wx.SysErrorMsg(errCode=0)

返回与给定系统错误码相对应的错误消息。

如果errCode为 0(默认值),则使用上一个错误码(由wx.SysErrorCode返回)。

特别是在多线程应用程序中,请使用wx.SysErrorMsgStr而不是此函数。

参数:

errCode (long) –

返回类型:

string

另请参阅wx.SysErrorCodewx.LogSysError

wx.SysErrorMsgStr

wx.SysErrorMsgStr(errCode=0)

返回与给定系统错误代码相对应的错误消息。

如果错误代码errCode为 0(默认值),则使用上一个错误代码(即由wx.SysErrorCode返回的错误代码)。

请使用此函数代替wx.SysErrorMsg,因为后者不是线程安全的。

参数:

errCode (long) –

返回类型:

string

4.1版本/wxWidgets-3.1.0新增。

另请参阅wx.SysErrorCodewx.LogSysError

T

wx.Trap

wx.Trap()

生成一个调试器异常,这意味着如果有调试器附加到该进程,控制权将被传递给调试器。

否则,程序将只是异常终止。

如果DEBUG_LEVEL为 0(这不是默认值),则此函数不执行任何操作。

V

wx.version

wx.version()

返回一个包含版本和端口信息的字符串。

W

wx.WakeUpIdle

wx.WakeUpIdle()

此函数会唤醒(依赖于内部机制和平台的)空闲系统,也就是说, 即使系统当前处于空闲状态,它也会强制系统发送一个空闲事件。因此,在有其他事件发送之前,系统原本不会发送任何空闲事件,但通过此函数就能促使其发送。这对于在两个线程之间发送事件也很有用,并且被相应的函数wx.PostEventwx.EvtHandler.AddPendingEvent所使用。

Y

wx.Yield

wx.Yield()

如果存在现有的应用程序对象,则调用wx.AppConsole.Yield

如果没有应用程序(这种情况通常仅发生在程序启动初期或关闭后期),则不执行任何操作。

返回类型:

bool

另请参阅EvtLoopBase.Yield()

wx.YieldIfNeeded

wx.YieldIfNeeded()

wx.GetApp().Yield(True)的便捷函数。