/usr/lib/python3/dist-packages/wx/html2.pyi is in python3-wxgtk-webview4.0 4.0.1+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 | # -*- coding: utf-8 -*-
#---------------------------------------------------------------------------
# This file is generated by wxPython's PI generator. Do not edit by hand.
#
# The *.pyi files are used by PyCharm and other development tools to provide
# more information, such as PEP 484 type hints, than it is able to glean from
# introspection of extension types and methods. They are not intended to be
# imported, executed or used for any other purpose other than providing info
# to the tools. If you don't use use a tool that makes use of .pyi files then
# you can safely ignore this file.
#
# See: https://www.python.org/dev/peps/pep-0484/
# https://www.jetbrains.com/help/pycharm/2016.1/type-hinting-in-pycharm.html
#
# Copyright: (c) 2017 by Total Control Software
# License: wxWindows License
#---------------------------------------------------------------------------
"""
The ``wx.html2`` module includes a widget class and supporting classes that
wraps native browser components on the system, therefore providing a fully
featured HTML rendering component including the latest HTML, Javascript and
CSS standards. Since platform-specific back-ends are used (Microsoft Trident,
WebKit webView, etc.) there will be some difference in ability and behaviors,
but these classes will minimize those differences as much as possible.
"""
#-- begin-_html2 --#
import wx
#-- end-_html2 --#
#-- begin-webview --#
WEBVIEW_ZOOM_TINY = 0
WEBVIEW_ZOOM_SMALL = 0
WEBVIEW_ZOOM_MEDIUM = 0
WEBVIEW_ZOOM_LARGE = 0
WEBVIEW_ZOOM_LARGEST = 0
WEBVIEW_ZOOM_TYPE_LAYOUT = 0
WEBVIEW_ZOOM_TYPE_TEXT = 0
WEBVIEW_NAV_ERR_CONNECTION = 0
WEBVIEW_NAV_ERR_CERTIFICATE = 0
WEBVIEW_NAV_ERR_AUTH = 0
WEBVIEW_NAV_ERR_SECURITY = 0
WEBVIEW_NAV_ERR_NOT_FOUND = 0
WEBVIEW_NAV_ERR_REQUEST = 0
WEBVIEW_NAV_ERR_USER_CANCELLED = 0
WEBVIEW_NAV_ERR_OTHER = 0
WEBVIEW_RELOAD_DEFAULT = 0
WEBVIEW_RELOAD_NO_CACHE = 0
WEBVIEW_FIND_WRAP = 0
WEBVIEW_FIND_ENTIRE_WORD = 0
WEBVIEW_FIND_MATCH_CASE = 0
WEBVIEW_FIND_HIGHLIGHT_RESULT = 0
WEBVIEW_FIND_BACKWARDS = 0
WEBVIEW_FIND_DEFAULT = 0
wxEVT_WEBVIEW_NAVIGATING = 0
wxEVT_WEBVIEW_NAVIGATED = 0
wxEVT_WEBVIEW_LOADED = 0
wxEVT_WEBVIEW_ERROR = 0
wxEVT_WEBVIEW_NEWWINDOW = 0
wxEVT_WEBVIEW_TITLE_CHANGED = 0
class WebViewHistoryItem(object):
"""
WebViewHistoryItem(url, title)
A simple class that contains the URL and title of an element of the
history of a wxWebView.
"""
def __init__(self, url, title):
"""
WebViewHistoryItem(url, title)
A simple class that contains the URL and title of an element of the
history of a wxWebView.
"""
def GetUrl(self):
"""
GetUrl() -> String
"""
def GetTitle(self):
"""
GetTitle() -> String
"""
Title = property(None, None)
Url = property(None, None)
# end of class WebViewHistoryItem
class WebViewHandler(object):
"""
WebViewHandler(scheme)
The base class for handling custom schemes in wxWebView, for example
to allow virtual file system support.
"""
def __init__(self, scheme):
"""
WebViewHandler(scheme)
The base class for handling custom schemes in wxWebView, for example
to allow virtual file system support.
"""
def GetFile(self, uri):
"""
GetFile(uri) -> wx.FSFile
"""
def GetName(self):
"""
GetName() -> String
"""
Name = property(None, None)
# end of class WebViewHandler
class WebViewArchiveHandler(WebViewHandler):
"""
WebViewArchiveHandler(scheme)
A custom handler for the file scheme which also supports loading from
archives.
"""
def __init__(self, scheme):
"""
WebViewArchiveHandler(scheme)
A custom handler for the file scheme which also supports loading from
archives.
"""
def GetFile(self, uri):
"""
GetFile(uri) -> wx.FSFile
"""
# end of class WebViewArchiveHandler
class WebViewFSHandler(WebViewHandler):
"""
WebViewFSHandler(scheme)
A wxWebView file system handler to support standard wxFileSystem
protocols of the form example:page.htm The handler allows wxWebView
to use wxFileSystem in a similar fashion to its use with wxHtml.
"""
def __init__(self, scheme):
"""
WebViewFSHandler(scheme)
A wxWebView file system handler to support standard wxFileSystem
protocols of the form example:page.htm The handler allows wxWebView
to use wxFileSystem in a similar fashion to its use with wxHtml.
"""
def GetFile(self, uri):
"""
GetFile(uri) -> wx.FSFile
"""
# end of class WebViewFSHandler
WebViewNameStr = ""
WebViewDefaultURLStr = ""
class WebView(wx.Control):
"""
This control may be used to render web (HTML / CSS / javascript)
documents.
"""
def CanCopy(self):
"""
CanCopy() -> bool
Returns true if the current selection can be copied.
"""
def CanCut(self):
"""
CanCut() -> bool
Returns true if the current selection can be cut.
"""
def CanPaste(self):
"""
CanPaste() -> bool
Returns true if data can be pasted.
"""
def Copy(self):
"""
Copy()
Copies the current selection.
"""
def Cut(self):
"""
Cut()
Cuts the current selection.
"""
def Paste(self):
"""
Paste()
Pastes the current data.
"""
def EnableContextMenu(self, enable=True):
"""
EnableContextMenu(enable=True)
Enable or disable the right click context menu.
"""
def IsContextMenuEnabled(self):
"""
IsContextMenuEnabled() -> bool
Returns true if a context menu will be shown on right click.
"""
def CanGoBack(self):
"""
CanGoBack() -> bool
Returns true if it is possible to navigate backward in the history of
visited pages.
"""
def CanGoForward(self):
"""
CanGoForward() -> bool
Returns true if it is possible to navigate forward in the history of
visited pages.
"""
def ClearHistory(self):
"""
ClearHistory()
Clear the history, this will also remove the visible page.
"""
def EnableHistory(self, enable=True):
"""
EnableHistory(enable=True)
Enable or disable the history.
"""
def GetBackwardHistory(self):
"""
GetBackwardHistory() -> PyObject
Returns a list of items in the back history.
"""
def GetForwardHistory(self):
"""
GetForwardHistory() -> PyObject
Returns a list of items in the forward history.
"""
def GoBack(self):
"""
GoBack()
Navigate back in the history of visited pages.
"""
def GoForward(self):
"""
GoForward()
Navigate forward in the history of visited pages.
"""
def ClearSelection(self):
"""
ClearSelection()
Clears the current selection.
"""
def DeleteSelection(self):
"""
DeleteSelection()
Deletes the current selection.
"""
def GetSelectedSource(self):
"""
GetSelectedSource() -> String
Returns the currently selected source, if any.
"""
def GetSelectedText(self):
"""
GetSelectedText() -> String
Returns the currently selected text, if any.
"""
def HasSelection(self):
"""
HasSelection() -> bool
Returns true if there is a current selection.
"""
def SelectAll(self):
"""
SelectAll()
Selects the entire page.
"""
def CanRedo(self):
"""
CanRedo() -> bool
Returns true if there is an action to redo.
"""
def CanUndo(self):
"""
CanUndo() -> bool
Returns true if there is an action to undo.
"""
def Redo(self):
"""
Redo()
Redos the last action.
"""
def Undo(self):
"""
Undo()
Undos the last action.
"""
def Find(self, text, flags=WEBVIEW_FIND_DEFAULT):
"""
Find(text, flags=WEBVIEW_FIND_DEFAULT) -> long
Finds a phrase on the current page and if found, the control will
scroll the phrase into view and select it.
"""
def CanSetZoomType(self, type):
"""
CanSetZoomType(type) -> bool
Retrieve whether the current HTML engine supports a zoom type.
"""
def GetZoom(self):
"""
GetZoom() -> WebViewZoom
Get the zoom factor of the page.
"""
def GetZoomType(self):
"""
GetZoomType() -> WebViewZoomType
Get how the zoom factor is currently interpreted.
"""
def SetZoom(self, zoom):
"""
SetZoom(zoom)
Set the zoom factor of the page.
"""
def SetZoomType(self, zoomType):
"""
SetZoomType(zoomType)
Set how to interpret the zoom factor.
"""
def Create(self, parent, id=wx.ID_ANY, url=WebViewDefaultURLStr, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name=WebViewNameStr):
"""
Create(parent, id=wx.ID_ANY, url=WebViewDefaultURLStr, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name=WebViewNameStr) -> bool
Creation function for two-step creation.
"""
def GetCurrentTitle(self):
"""
GetCurrentTitle() -> String
Get the title of the current web page, or its URL/path if title is not
available.
"""
def GetCurrentURL(self):
"""
GetCurrentURL() -> String
Get the URL of the currently displayed document.
"""
def GetNativeBackend(self):
"""
GetNativeBackend() -> void
Return the pointer to the native backend used by this control.
"""
def GetPageSource(self):
"""
GetPageSource() -> String
Get the HTML source code of the currently displayed document.
"""
def GetPageText(self):
"""
GetPageText() -> String
Get the text of the current page.
"""
def IsBusy(self):
"""
IsBusy() -> bool
Returns whether the web control is currently busy (e.g. loading a
page).
"""
def IsEditable(self):
"""
IsEditable() -> bool
Returns whether the web control is currently editable.
"""
def LoadURL(self, url):
"""
LoadURL(url)
Load a web page from a URL.
"""
def Print(self):
"""
Print()
Opens a print dialog so that the user may print the currently
displayed page.
"""
def RegisterHandler(self, handler):
"""
RegisterHandler(handler)
Registers a custom scheme handler.
"""
def Reload(self, flags=WEBVIEW_RELOAD_DEFAULT):
"""
Reload(flags=WEBVIEW_RELOAD_DEFAULT)
Reload the currently displayed URL.
"""
def RunScript(self, javascript):
"""
RunScript(javascript)
Runs the given javascript code.
"""
def SetEditable(self, enable=True):
"""
SetEditable(enable=True)
Set the editable property of the web control.
"""
def SetPage(self, *args, **kw):
"""
SetPage(html, baseUrl)
SetPage(html, baseUrl)
Set the displayed page source to the contents of the given string.
"""
def Stop(self):
"""
Stop()
Stop the current page loading process, if any.
"""
@staticmethod
def New(*args, **kw):
"""
New(backend=WebViewBackendDefault) -> WebView
New(parent, id=wx.ID_ANY, url=WebViewDefaultURLStr, pos=wx.DefaultPosition, size=wx.DefaultSize, backend=WebViewBackendDefault, style=0, name=WebViewNameStr) -> WebView
Factory function to create a new wxWebView with two-step creation,
wxWebView::Create should be called on the returned object.
"""
@staticmethod
def RegisterFactory(backend, factory):
"""
RegisterFactory(backend, factory)
Allows the registering of new backend for wxWebView.
"""
BackwardHistory = property(None, None)
CurrentTitle = property(None, None)
CurrentURL = property(None, None)
ForwardHistory = property(None, None)
NativeBackend = property(None, None)
PageSource = property(None, None)
PageText = property(None, None)
SelectedSource = property(None, None)
SelectedText = property(None, None)
Zoom = property(None, None)
ZoomType = property(None, None)
# end of class WebView
class WebViewEvent(wx.NotifyEvent):
"""
WebViewEvent()
WebViewEvent(type, id, href, target)
A navigation event holds information about events associated with
wxWebView objects.
"""
def __init__(self, *args, **kw):
"""
WebViewEvent()
WebViewEvent(type, id, href, target)
A navigation event holds information about events associated with
wxWebView objects.
"""
def GetTarget(self):
"""
GetTarget() -> String
Get the name of the target frame which the url of this event has been
or will be loaded into.
"""
def GetURL(self):
"""
GetURL() -> String
Get the URL being visited.
"""
Target = property(None, None)
URL = property(None, None)
# end of class WebViewEvent
class WebViewFactory(wx.Object):
"""
An abstract factory class for creating wxWebView backends.
"""
def Create(self, *args, **kw):
"""
Create() -> WebView
Create(parent, id, url=WebViewDefaultURLStr, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name=WebViewNameStr) -> WebView
Function to create a new wxWebView with two-step creation,
wxWebView::Create should be called on the returned object.
"""
# end of class WebViewFactory
WebViewBackendDefault = ""
WebViewBackendIE = ""
WebViewBackendWebKit = ""
EVT_WEBVIEW_NAVIGATING = wx.PyEventBinder( wxEVT_WEBVIEW_NAVIGATING, 1 )
EVT_WEBVIEW_NAVIGATED = wx.PyEventBinder( wxEVT_WEBVIEW_NAVIGATED, 1 )
EVT_WEBVIEW_LOADED = wx.PyEventBinder( wxEVT_WEBVIEW_LOADED, 1 )
EVT_WEBVIEW_ERROR = wx.PyEventBinder( wxEVT_WEBVIEW_ERROR, 1 )
EVT_WEBVIEW_NEWWINDOW = wx.PyEventBinder( wxEVT_WEBVIEW_NEWWINDOW, 1 )
EVT_WEBVIEW_TITLE_CHANGED = wx.PyEventBinder( wxEVT_WEBVIEW_TITLE_CHANGED, 1 )
# deprecated wxEVT aliases
wxEVT_COMMAND_WEBVIEW_NAVIGATING = wxEVT_WEBVIEW_NAVIGATING
wxEVT_COMMAND_WEBVIEW_NAVIGATED = wxEVT_WEBVIEW_NAVIGATED
wxEVT_COMMAND_WEBVIEW_LOADED = wxEVT_WEBVIEW_LOADED
wxEVT_COMMAND_WEBVIEW_ERROR = wxEVT_WEBVIEW_ERROR
wxEVT_COMMAND_WEBVIEW_NEWWINDOW = wxEVT_WEBVIEW_NEWWINDOW
wxEVT_COMMAND_WEBVIEW_TITLE_CHANGED = wxEVT_WEBVIEW_TITLE_CHANGED
#-- end-webview --#
|