diff --git a/.flake8 b/.flake8 index a5dfe806..e6aff2b6 100644 --- a/.flake8 +++ b/.flake8 @@ -1,8 +1,6 @@ [flake8] color=always max-line-length=120 -; TODO: Bring WAY down -max-complexity=55 ; Auto generated exclude=src/gen/ ; TODO: We want to configure this @@ -12,3 +10,6 @@ per-file-ignores = ; line too long ; mixed case __init__.pyi:F401,E501,N816 +; TODO: Bring WAY down +max-complexity=55 +inline-quotes = " diff --git a/.github/workflows/build-and-lint.yml b/.github/workflows/build-and-lint.yml new file mode 100644 index 00000000..ae10b564 --- /dev/null +++ b/.github/workflows/build-and-lint.yml @@ -0,0 +1,111 @@ +# https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions +name: Build and lint +on: + push: + branches: + - main + - master + - 2.0.0 + pull_request: + branches: + - main + - master + - dev + - dev* +jobs: + Pyright: + runs-on: windows-latest + strategy: + matrix: + python-version: ["3.8", "3.9"] + steps: + - name: Checkout ${{ github.repository }}/${{ github.ref }} + uses: actions/checkout@v2 + - name: Set up Node + uses: actions/setup-node@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r "scripts/requirements.txt" + npm install -g pyright + - run: scripts/compile_resources.bat + - name: Analysing the code with ${{ job.name }} + run: pyright + Pylint: + runs-on: windows-latest + strategy: + matrix: + python-version: ["3.8", "3.9"] + steps: + - name: Checkout ${{ github.repository }}/${{ github.ref }} + uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r "scripts/requirements.txt" + - run: scripts/compile_resources.bat + - name: Analysing the code with ${{ job.name }} + run: pylint --reports=y --output-format=colorized $(git ls-files '**/*.py*') + Bandit: + runs-on: windows-latest + strategy: + matrix: + python-version: ["3.8", "3.9"] + steps: + - name: Checkout ${{ github.repository }}/${{ github.ref }} + uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r "scripts/requirements.txt" + - run: scripts/compile_resources.bat + - name: Analysing the code with ${{ job.name }} + run: bandit -n 1 --severity-level medium --recursive src + Flake8: + runs-on: windows-latest + strategy: + matrix: + python-version: ["3.8", "3.9"] + steps: + - name: Checkout ${{ github.repository }}/${{ github.ref }} + uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r "scripts/requirements.txt" + - run: scripts/compile_resources.bat + - name: Analysing the code with ${{ job.name }} + run: flake8 + Build: + runs-on: windows-latest + strategy: + matrix: + python-version: ["3.8", "3.9"] + steps: + - name: Checkout ${{ github.repository }}/${{ github.ref }} + uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r "scripts/requirements.txt" + - run: scripts/build.bat diff --git a/.mypy.ini b/.mypy.ini deleted file mode 100644 index 6b23dbbd..00000000 --- a/.mypy.ini +++ /dev/null @@ -1,33 +0,0 @@ -; https://mypy.readthedocs.io/en/stable/command_line.html#disallow-dynamic-typing -[mypy] -show_column_numbers=True -show_error_codes=True -no_color_output=False -color_output=True - -ignore_missing_imports=True -follow_imports=silent - -; Note: exclude is ignored when linting file by file so VSCode will still show errors in typings -; typings are incomplete as we only add types for what we need, cannot disable specific rules per file -; Auto generated -exclude=(typings/|src/gen/) - -; Redundant -disallow_untyped_defs=False -; Doesn't see our cv2 type stubs -warn_return_any=False -; False positives when it's needed for other linting libraries -warn_unused_ignores=False -; Doesn't see imports from src/gen/ -disallow_any_unimported=False -disallow_subclassing_any=False -; False positives with ndarray -disable_error_code=no-untyped-def - -strict=True -; Doesn't see types from some imports -disallow_any_expr=False -disallow_any_decorated=True -disallow_any_explicit=True -warn_unreachable=True diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 8bd9be7a..00000000 --- a/.pylintrc +++ /dev/null @@ -1,23 +0,0 @@ -; http://pylint-messages.wikidot.com/all-codes -[MASTER] -max-line-length=120 -ignore-paths= - ; Haven't looked into disabling specific rules per file - ^typings/.*$, - ; Auto generated - ^src/gen/.*$ -disable= - missing-docstring, - ; TODO: We want to configure this - ; https://pylint.pycqa.org/en/latest/user_guide/options.html#naming-styles - invalid-name, - ; We group imports - wrong-import-position, - ; Already taken care of and grayed out. Also conflicts with Pylance reportIncompatibleMethodOverride - unused-argument, - ; Already taken care of by Flake8 - unused-import, -extension-pkg-allow-list=PyQt6,win32ui - -[TYPECHECK] -generated-members=cv2 diff --git a/.vscode/extensions.json b/.vscode/extensions.json index ca9b77ca..d4464eda 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,11 +1,12 @@ { "recommendations": [ - "ms-python.vscode-pylance", - "ms-python.python", - "sonarsource.sonarlint-vscode", + "bungcip.better-toml", "davidanson.vscode-markdownlint", + "eamodio.gitlens", + "ms-python.python", + "ms-python.vscode-pylance", "shardulm94.trailing-spaces", - "eamodio.gitlens" + "sonarsource.sonarlint-vscode" ], "unwantedRecommendations": [ "ms-pyright.pyright", diff --git a/.vscode/settings.json b/.vscode/settings.json index 2f06bd99..5336311a 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -13,9 +13,11 @@ "[python]": { "editor.tabSize": 4, "editor.rulers": [ - 79, - 100, - 120, + 72, // PEP8-17 docstrings + // 79, // PEP8-17 default max + // 88, // Black default + 99, // PEP8-17 acceptable max + 120, // Our hard rule ] }, "editor.formatOnSave": true, @@ -23,16 +25,14 @@ "source.fixAll": true, "source.fixAll.markdownlint": true, }, - // Set to trace when sending error reports to Pylance - // "python.analysis.logLevel": "Trace", - // https://code.visualstudio.com/docs/python/linting#_specific-linters "python.linting.enabled": true, "python.linting.pylintEnabled": true, "python.linting.pylintCategorySeverity.convention": "Warning", "python.linting.pylintCategorySeverity.refactor": "Warning", "python.linting.flake8Enabled": true, "python.linting.flake8CategorySeverity.E": "Warning", - "python.linting.mypyEnabled": true, + // PyRight obsoletes mypy + "python.linting.mypyEnabled": false, // Is already wrapped by Flake8, prospector and pylama "python.linting.pycodestyleEnabled": false, // Just another wrapper, use Flake8 OR this @@ -66,5 +66,5 @@ "**/bower_components": true, "**/*.code-search": true, "typings": true, - } + }, } diff --git a/README.md b/README.md index f11ae3e3..7a4896bc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# LiveSplit AutoSplit +# LiveSplit AutoSplit [![Build and lint](/../../actions/workflows/build-and-lint.yml/badge.svg)](/../../actions/workflows/build-and-lint.yml) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=Avasam_Auto-Split) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=Avasam_Auto-Split) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=security_rating)](https://sonarcloud.io/dashboard?id=Avasam_Auto-Split) [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=Avasam_Auto-Split) Easy to use image comparison based auto splitter for speedrunning on console or PC. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..4a532389 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,96 @@ +# https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file +[tool.black] +line-length = 120 +# Auto generated +force-exclude = "src/gen/.*\\.py$" + +# https://github.com/hhatto/autopep8#usage +# https://github.com/hhatto/autopep8#more-advanced-usage +[tool.autopep8] +max_line_length = 120 +recursive = true +aggressive = 3 + +# https://github.com/microsoft/pyright/blob/main/docs/configuration.md#sample-pyprojecttoml-file +[tool.pyright] +pythonPlatform = "Windows" +typeCheckingMode = "strict" +stubPath = "typings/" +ignore = [ + # Auto generated + "src/gen/", + "typings/", +] +reportMissingTypeStubs = "information" +# False positives with TYPE_CHECKING +reportImportCycles = "information" +# PyQt .connect +reportFunctionMemberAccess = "information" +# Extra runtime safety +reportUnnecessaryComparison = "warning" +# Flake8 does a better job +reportUnusedImport = "none" +# numpy has way too many complex types that triggers this +reportUnknownMemberType = "none" + +# https://github.com/PyCQA/pylint/blob/main/examples/pylintrc +# https://pylint.pycqa.org/en/latest/technical_reference/features.html +[tool.pylint.REPORTS] +# Just like default but any error will make drop to 9 or less +evaluation="10.0 - error - ((float(warning + refactor + convention) / statement) * 10)" +[tool.pylint.MASTER] +fail-under=9.0 +# https://pylint.pycqa.org/en/latest/technical_reference/extensions.html +load-plugins = [ + "pylint.extensions.emptystring", + "pylint.extensions.confusing_elif", + "pylint.extensions.consider_ternary_expression", + "pylint.extensions.bad_builtin", + "pylint.extensions.mccabe", + "pylint.extensions.check_elif", + "pylint.extensions.redefined_variable_type", + "pylint.extensions.overlapping_exceptions", + "pylint.extensions.empty_comment", + "pylint.extensions.set_membership", + "pylint.extensions.typing", + # TODO: Maybe later + # "pylint.extensions.docparams", + # Not wanted/needed + # "pylint.extensions.broad_try_clause", + # "pylint.extensions.code_style", + # "pylint.extensions.comparetozero", + # "pylint.extensions.docstyle", + # "pylint.extensions.while_used", + # Didn't work + # "pylint.extensions.comparison_placement", + # "pylint.extensions.for_any_all", +] +ignore-paths = [ + # Haven't looked into disabling specific rules per file + "^typings/.*$", + # Auto generated + "^src/gen/.*$", +] +# No need to mention the fixmes +disable=["fixme"] +extension-pkg-allow-list = ["PyQt6", "win32ui"] + +[tool.pylint.FORMAT] +max-line-length = 120 + +[tool.pylint.'MESSAGES CONTROL'] +disable = [ + "missing-docstring", + # TODO: We want to configure this + # https://pylint.pycqa.org/en/latest/user_guide/options.html#naming-styles + "invalid-name", + # We group imports + "wrong-import-position", + # Already taken care of and grayed out. Also conflicts with Pylance reportIncompatibleMethodOverride + "unused-argument", + # Already taken care of by Flake8 + "unused-import", +] + +[tool.pylint.TYPECHECK] +generated-members = "cv2" diff --git a/pyrightconfig.json b/pyrightconfig.json deleted file mode 100644 index 5aaa8948..00000000 --- a/pyrightconfig.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "typeCheckingMode": "strict", - // Auto generated - "ignore": [ - // "src/gen/", - "typings/", - ], - "reportMissingTypeStubs": "information", - // False positives with TYPE_CHECKING - "reportImportCycles": "information", - // PyQt .connect - "reportFunctionMemberAccess": "information", - // Extra runtime safety - "reportUnnecessaryComparison": "warning", - // Flake8 does a better job - "reportUnusedImport": "none", - // numpy has way too many complex types that triggers this - "reportUnknownMemberType": "none", -} diff --git a/res/design.ui b/res/design.ui index 1e74b9d8..af4e7559 100644 --- a/res/design.ui +++ b/res/design.ui @@ -615,7 +615,7 @@ 450 - 50 + 38 102 16 @@ -705,7 +705,7 @@ 200 - 50 + 38 82 16 @@ -759,7 +759,7 @@ 380 - 270 + 50 241 20 @@ -1076,10 +1076,10 @@ - 120 + 440 270 - 241 - 16 + 181 + 20 @@ -1112,6 +1112,38 @@ + + + + 120 + 50 + 241 + 20 + + + + + + + Qt::AlignLeading|Qt::AlignLeft|Qt::AlignVCenter + + + + + true + + + + 120 + 270 + 221 + 20 + + + + Force Full Content Rendering (slower) + + splitimagefolderLabel splitimagefolderLineEdit browseButton @@ -1178,6 +1210,8 @@ startImageLabel currentsimilaritythresholdLabel currentsimilaritythresholdnumberLabel + captureregionwindowLabel + forcePrintWindowCheckBox diff --git a/scripts/Qt Designer.lnk b/scripts/Qt Designer.lnk deleted file mode 100644 index 32ad191e..00000000 Binary files a/scripts/Qt Designer.lnk and /dev/null differ diff --git a/scripts/install.bat b/scripts/install.bat index a824c7b4..b32ff99e 100644 --- a/scripts/install.bat +++ b/scripts/install.bat @@ -1,6 +1,4 @@ py -3.9 -m pip install wheel py -3.9 -m pip install -r "%~p0requirements.txt" -@REM https://github.com/python/mypy/issues/10600 --non-interactive may still have issues -mypy --install-types --non-interactive npm install -g pyright CALL "%~p0compile_resources.bat" diff --git a/scripts/lint.ps1 b/scripts/lint.ps1 index 298956ce..97a72d41 100644 --- a/scripts/lint.ps1 +++ b/scripts/lint.ps1 @@ -1,8 +1,11 @@ -pylint --score=n --output-format=text,colorized $(git ls-files '**/*.py*') -# pylint --reports=y --output-format=text,colorized $(git ls-files '**/*.py*') -mypy . -# mypy --pretty src +echo "`nRunning Pyright..." pyright -bandit -f custom --silent --severity-level medium -r . -# bandit -n 1 --severity-level medium -r src + +echo "`nRunning Pylint..." +pylint --score=n --output-format=colorized $(git ls-files '**/*.py*') + +echo "`nRunning Bandit..." +bandit -f custom --silent --recursive src + +echo "`nRunning Flake8..." flake8 diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 71cf1231..30cf1dab 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -11,23 +11,23 @@ # # Dependencies: numpy>=1.22.0rc1 -opencv-python<=4.5.3.56 # https://github.com/pyinstaller/pyinstaller-hooks-contrib/issues/110 +opencv-python<=4.5.3.56 # https://github.com/pyinstaller/pyinstaller-hooks-contrib/issues/110 PyQt6 +PyQt6-tools +PySide6 Pillow ImageHash pywin32 -pywin32-stubs keyboard packaging pyautogui -PySide6 +requests +# Linting and Types +pywin32-stubs +types-requests flake8 -mypy pylint -requests +bandit # # Comment this out if you don't want to build AutoSplit.exe: PyInstaller -# -# Comment this out if you don't want to install the PyQt designer -PyQt6-tools diff --git a/src/AutoControlledWorker.py b/src/AutoControlledWorker.py index fef30676..7ef33a0c 100644 --- a/src/AutoControlledWorker.py +++ b/src/AutoControlledWorker.py @@ -5,6 +5,7 @@ from PyQt6 import QtCore import error_messages +import settings_file as settings class AutoControlledWorker(QtCore.QObject): @@ -22,21 +23,21 @@ def run(self): # TODO: "AutoSplit Integration" needs to call this and wait instead of outright killing the app. # TODO: See if we can also get LiveSplit to wait on Exit in "AutoSplit Integration" # For now this can only used in a Development environment - if line == 'kill': + if line == "kill": self.autosplit.closeEvent() break - elif line == 'start': + if line == "start": self.autosplit.startAutoSplitter() - elif line == 'split' or line == 'skip': + elif line in {"split", "skip"}: self.autosplit.startSkipSplit() - elif line == 'undo': + elif line == "undo": self.autosplit.startUndoSplit() - elif line == 'reset': + elif line == "reset": self.autosplit.startReset() - elif line.startswith('settings'): + elif line.startswith("settings"): # Allow for any split character between "settings" and the path self.autosplit.load_settings_file_path = line[9:] - self.autosplit.loadSettings(load_settings_from_livesplit=True) + settings.loadSettings(self.autosplit, load_settings_from_livesplit=True) # TODO: Not yet implemented in AutoSplit Integration # elif line == 'pause': # self.startPause() diff --git a/src/AutoSplit.py b/src/AutoSplit.py index b35b5c2a..40e81aea 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -1,4 +1,4 @@ -#!/usr/bin/python3.9 +#!/usr/bin/python3 # -*- coding: utf-8 -*- # Imports grouping: @@ -7,8 +7,9 @@ # - Externals # - Internals from __future__ import annotations +from collections.abc import Callable from types import FunctionType, TracebackType -from typing import Callable, List, Literal, Optional, Type, Union, cast +from typing import Literal, Optional, Union, cast import sys import os @@ -26,12 +27,15 @@ from win32con import MAXBYTE import error_messages +import settings_file as settings import split_parser from AutoControlledWorker import AutoControlledWorker +from capture_windows import capture_region, Rect from gen import design +from hotkeys import send_command, afterSettingHotkey, setSplitHotkey, setResetHotkey, setSkipSplitHotkey, \ + setUndoSplitHotkey, setPauseHotkey from menu_bar import AboutWidget, VERSION, UpdateCheckerWidget, about, viewHelp, checkForUpdates -from capture_windows import capture_region, Rect -from settings_file import auto_split_directory +from screen_region import selectRegion, selectWindow, alignRegion, validateBeforeComparison from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG from compare import checkIfImageHasTransparency, compareImage @@ -49,19 +53,11 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): - # pylint: disable=import-outside-toplevel - from hotkeys import send_command - from settings_file import saveSettings, saveSettingsAs, loadSettings, haveSettingsChanged, getSaveSettingsValues, \ - loadPyQtSettings - from screen_region import selectRegion, selectWindow, alignRegion, validateBeforeComparison - from hotkeys import afterSettingHotkey, beforeSettingHotkey, setSplitHotkey, setResetHotkey, setSkipSplitHotkey, \ - setUndoSplitHotkey, setPauseHotkey - - myappid = f'Toufool.AutoSplit.v{VERSION}' + myappid = f"Toufool.AutoSplit.v{VERSION}" ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid) # Parse command line args - is_auto_controlled = '--auto-controlled' in sys.argv + is_auto_controlled = "--auto-controlled" in sys.argv # Signals updateCurrentSplitImage = QtCore.pyqtSignal(QtGui.QImage) @@ -93,11 +89,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): skip_split_key = "" undo_split_key = "" pause_key = "" - x: int - y: int - width: int - height: int - hwnd_title = '' + hwnd_title = "" group_dummy_splits_undo_skip_setting: Literal[0, 1] loop_setting: Literal[0, 1] auto_start_on_reset_setting: Literal[0, 1] @@ -115,16 +107,16 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): pause_hotkey: Optional[Callable[[], None]] = None # Initialize a few attributes - last_saved_settings: Optional[List[Union[str, float, int]]] = None + last_saved_settings: Optional[list[Union[str, float, int]]] = None save_settings_file_path = "" load_settings_file_path = "" live_image_function_on_open = True - split_image_loop_amount: List[int] = [] + split_image_loop_amount: list[int] = [] split_image_number = 0 loop_number = 1 # Last loaded settings and last successful loaded settings file path to None until we try to load them - last_loaded_settings: Optional[List[Union[str, float, int]]] = None + last_loaded_settings: Optional[list[Union[str, float, int]]] = None last_successfully_loaded_settings_file_path: Optional[str] = None # Automatic timer start @@ -133,19 +125,41 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): highest_similarity = 0.0 check_start_image_timestamp = 0.0 + # Define all other attributes + setting_check_for_updates_on_open: QtCore.QSettings + imageHasTransparency: bool + start_image_split_below_threshold: bool + waiting_for_split_delay: bool + split_below_threshold: bool + split_image_path: str + split_image_filenames: list[str] + split_image_filenames_including_loops: list[str] + split_image_filenames_and_loop_number: list[tuple[str, int, int]] + split_groups: list[list[int]] + run_start_time: float + similarity: float + reset_image_threshold: float + reset_image_pause_time: float + split_delay: float + flags: int + reset_image: Optional[cv2.ndarray] + reset_mask: Optional[cv2.ndarray] + split_image: cv2.ndarray + image_mask: Optional[cv2.ndarray] + def __init__(self, parent: Optional[QWidget] = None): super().__init__(parent) self.setupUi(self) - self.loadPyQtSettings() + settings.loadPyQtSettings(self) # close all processes when closing window self.actionView_Help.triggered.connect(viewHelp) self.actionAbout.triggered.connect(lambda: about(self)) self.actionCheck_for_Updates.triggered.connect(lambda: checkForUpdates(self)) - self.actionSave_Settings.triggered.connect(self.saveSettings) - self.actionSave_Settings_As.triggered.connect(self.saveSettingsAs) - self.actionLoad_Settings.triggered.connect(self.loadSettings) + self.actionSave_Settings.triggered.connect(lambda: settings.saveSettings(self)) + self.actionSave_Settings_As.triggered.connect(lambda: settings.saveSettingsAs(self)) + self.actionLoad_Settings.triggered.connect(lambda: settings.loadSettings(self)) # disable buttons upon open self.undosplitButton.setEnabled(False) @@ -177,24 +191,24 @@ def __init__(self, parent: Optional[QWidget] = None): self.update_auto_control.start() # split image folder line edit text - self.splitimagefolderLineEdit.setText('No Folder Selected') + self.splitimagefolderLineEdit.setText("No Folder Selected") # Connecting button clicks to functions self.browseButton.clicked.connect(self.browse) - self.selectregionButton.clicked.connect(self.selectRegion) + self.selectregionButton.clicked.connect(lambda: selectRegion(self)) self.takescreenshotButton.clicked.connect(self.takeScreenshot) self.startautosplitterButton.clicked.connect(self.autoSplitter) self.checkfpsButton.clicked.connect(self.checkFPS) self.resetButton.clicked.connect(self.reset) self.skipsplitButton.clicked.connect(self.skipSplit) self.undosplitButton.clicked.connect(self.undoSplit) - self.setsplithotkeyButton.clicked.connect(self.setSplitHotkey) - self.setresethotkeyButton.clicked.connect(self.setResetHotkey) - self.setskipsplithotkeyButton.clicked.connect(self.setSkipSplitHotkey) - self.setundosplithotkeyButton.clicked.connect(self.setUndoSplitHotkey) - self.setpausehotkeyButton.clicked.connect(self.setPauseHotkey) - self.alignregionButton.clicked.connect(self.alignRegion) - self.selectwindowButton.clicked.connect(self.selectWindow) + self.setsplithotkeyButton.clicked.connect(lambda: setSplitHotkey(self)) + self.setresethotkeyButton.clicked.connect(lambda: setResetHotkey(self)) + self.setskipsplithotkeyButton.clicked.connect(lambda: setSkipSplitHotkey(self)) + self.setundosplithotkeyButton.clicked.connect(lambda: setUndoSplitHotkey(self)) + self.setpausehotkeyButton.clicked.connect(lambda: setPauseHotkey(self)) + self.alignregionButton.clicked.connect(lambda: alignRegion(self)) + self.selectwindowButton.clicked.connect(lambda: selectWindow(self)) self.startImageReloadButton.clicked.connect(lambda: self.loadStartImage(True, True)) # update x, y, width, and height when changing the value of these spinbox's are changed @@ -205,7 +219,7 @@ def __init__(self, parent: Optional[QWidget] = None): # connect signals to functions self.updateCurrentSplitImage.connect(self.updateSplitImageGUI) - self.afterSettingHotkeySignal.connect(self.afterSettingHotkey) + self.afterSettingHotkeySignal.connect(lambda: afterSettingHotkey(self)) self.startAutoSplitterSignal.connect(self.autoSplitter) self.resetSignal.connect(self.reset) self.skipSplitSignal.connect(self.skipSplit) @@ -224,20 +238,20 @@ def __init__(self, parent: Optional[QWidget] = None): self.last_successfully_loaded_settings_file_path = None if not self.is_auto_controlled: - self.loadSettings(load_settings_on_open=True) + settings.loadSettings(self, load_settings_on_open=True) # FUNCTIONS def getGlobalSettingsValues(self): - self.setting_check_for_updates_on_open = QtCore.QSettings('AutoSplit', 'Check For Updates On Open') + self.setting_check_for_updates_on_open = QtCore.QSettings("AutoSplit", "Check For Updates On Open") # TODO add checkbox for going back to image 1 when resetting. def browse(self): # User selects the file with the split images in it. new_split_image_directory = QFileDialog.getExistingDirectory( self, - 'Select Split Image Directory', - os.path.join(self.split_image_directory or auto_split_directory, "..")) + "Select Split Image Directory", + os.path.join(self.split_image_directory or settings.auto_split_directory, "..")) # If the user doesn't select a folder, it defaults to "". if new_split_image_directory: @@ -255,16 +269,18 @@ def checkLiveImage(self): def liveImageFunction(self): try: - if not win32gui.GetWindowText(self.hwnd): + windowText = win32gui.GetWindowText(self.hwnd) + self.captureregionwindowLabel.setText(windowText) + if not windowText: self.timerLiveImage.stop() + self.liveImage.clear() if self.live_image_function_on_open: self.live_image_function_on_open = False else: - self.liveImage.clear() error_messages.regionError() return - capture = capture_region(self.hwnd, self.selection) + capture = capture_region(self.hwnd, self.selection, self.forcePrintWindowCheckBox.isChecked()) capture = cv2.resize(capture, DISPLAY_RESIZE, interpolation=cv2.INTER_NEAREST) capture = cv2.cvtColor(capture, cv2.COLOR_BGRA2RGB) @@ -283,29 +299,33 @@ def liveImageFunction(self): def loadStartImage(self, started_by_button: bool = False, wait_for_delay: bool = True): self.timerStartImage.stop() - self.currentsplitimagefileLabel.setText(' ') + self.currentsplitimagefileLabel.setText(" ") self.startImageLabel.setText("Start image: not found") QApplication.processEvents() - if not self.validateBeforeComparison(started_by_button): + if not validateBeforeComparison(self, started_by_button): return self.start_image_name = None for image in os.listdir(self.split_image_directory): - if 'start_auto_splitter' in image.lower(): + if "start_auto_splitter" in image.lower(): if self.start_image_name is None: self.start_image_name = image else: if started_by_button: - error_messages.multipleKeywordImagesError('start_auto_splitter') + error_messages.multipleKeywordImagesError("start_auto_splitter") return if self.start_image_name is None: if started_by_button: - error_messages.noKeywordImageError('start_auto_splitter') + error_messages.noKeywordImageError("start_auto_splitter") return - if self.start_image_name is not None and (not self.splitLineEdit.text() or not self.resetLineEdit.text() or not self.pausehotkeyLineEdit.text()) and not self.is_auto_controlled: + if self.start_image_name is not None \ + and not self.is_auto_controlled \ + and (not self.splitLineEdit.text() + or not self.resetLineEdit.text() + or not self.pausehotkeyLineEdit.text()): error_messages.loadStartImageError() return @@ -339,8 +359,8 @@ def loadStartImage(self, started_by_button: bool = False, wait_for_delay: bool = if not wait_for_delay and start_image_pause is not None and start_image_pause > 0: self.check_start_image_timestamp = time() + start_image_pause self.startImageLabel.setText("Start image: paused") - self.highestsimilarityLabel.setText(' ') - self.currentsimilaritythresholdnumberLabel.setText(' ') + self.highestsimilarityLabel.setText(" ") + self.currentsimilaritythresholdnumberLabel.setText(" ") else: self.check_start_image_timestamp = 0.0 self.startImageLabel.setText("Start image: ready") @@ -360,7 +380,7 @@ def startImageFunction(self): or (not self.splitLineEdit.text() and not self.is_auto_controlled): pause_time_left = f"{self.check_start_image_timestamp - time():.1f}" self.currentSplitImage.setText( - f'None\n (Paused before loading Start Image).\n {pause_time_left} sec remaining') + f"None\n (Paused before loading Start Image).\n {pause_time_left} sec remaining") return if self.check_start_image_timestamp > 0: @@ -383,7 +403,7 @@ def startImageFunction(self): # Show live similarity if the checkbox is checked self.livesimilarityLabel.setText(str(start_image_similarity)[:4] if self.showlivesimilarityCheckBox.isChecked() - else ' ') + else " ") # If the similarity becomes higher than highest similarity, set it as such. if start_image_similarity > self.highest_similarity: @@ -392,7 +412,7 @@ def startImageFunction(self): # Show live highest similarity if the checkbox is checked self.highestsimilarityLabel.setText(str(self.highest_similarity)[:4] if self.showlivesimilarityCheckBox.isChecked() - else ' ') + else " ") # If the {b} flag is set, let similarity go above threshold first, then split on similarity below threshold # Otherwise just split when similarity goes above threshold @@ -406,7 +426,7 @@ def startImageFunction(self): and start_image_similarity < start_image_threshold) \ or (start_image_similarity >= start_image_threshold and not start_image_flags & BELOW_FLAG): def split(): - self.send_command("start") + send_command(self, "start") # Email sent to pyqt@riverbankcomputing.com QtTest.QTest.qWait(1 / self.fpslimitSpinBox.value()) # type: ignore self.startAutoSplitter() @@ -420,7 +440,7 @@ def split(): delay_start_time = time() while time() - delay_start_time < (start_image_delay / 1000): delay_time_left = round((start_image_delay / 1000) - (time() - delay_start_time), 1) - self.currentSplitImage.setText(f'Delayed Before Starting:\n {delay_time_left} sec remaining') + self.currentSplitImage.setText(f"Delayed Before Starting:\n {delay_time_left} sec remaining") # Email sent to pyqt@riverbankcomputing.com QtTest.QTest.qWait(1) # type: ignore @@ -458,9 +478,9 @@ def updateSplitImageGUI(self, qImage: QtGui.QImage): self.currentSplitImage.setPixmap(pix) def takeScreenshot(self): - if not self.validateBeforeComparison(check_empty_directory=False): + if not validateBeforeComparison(self, check_empty_directory=False): return - take_screenshot_filename = '001_SplitImage' + take_screenshot_filename = "001_SplitImage" # check if file exists and rename it if it does # Below starts the FileNameNumber at #001 up to #999. After that it will go to 1000, @@ -472,7 +492,7 @@ def takeScreenshot(self): i += 1 # grab screenshot of capture region - capture = capture_region(self.hwnd, self.selection) + capture = capture_region(self.hwnd, self.selection, self.forcePrintWindowCheckBox.isChecked()) capture = cv2.cvtColor(capture, cv2.COLOR_BGRA2BGR) # save and open image @@ -482,7 +502,7 @@ def takeScreenshot(self): # check max FPS button connects here. # TODO: Average on all images and check for transparency (cv2.COLOR_BGRA2RGB and cv2.IMREAD_UNCHANGED) def checkFPS(self): - if not self.validateBeforeComparison(): + if not validateBeforeComparison(self): return split_image_filenames = os.listdir(self.split_image_directory) @@ -490,9 +510,9 @@ def checkFPS(self): cv2.imread(os.path.join(self.split_image_directory, image), cv2.IMREAD_COLOR) for image in split_image_filenames] - for image in split_images: + for i, image in enumerate(split_images): if image is None: - error_messages.imageTypeError(image) + error_messages.imageTypeError(split_image_filenames[i]) return # grab first image in the split image folder @@ -504,7 +524,7 @@ def checkFPS(self): count = 0 t0 = time() while count < 10: - capture = capture_region(self.hwnd, self.selection) + capture = capture_region(self.hwnd, self.selection, self.forcePrintWindowCheckBox.isChecked()) capture = cv2.resize(capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST) capture = cv2.cvtColor(capture, cv2.COLOR_BGRA2RGB) compareImage(self.comparisonmethodComboBox.currentIndex(), split_image, capture) @@ -523,7 +543,7 @@ def is_current_split_out_of_range(self): def undoSplit(self): # Can't undo until timer is started # or Undoing past the first image - if self.startautosplitterButton.text() == 'Start Auto Splitter' \ + if self.startautosplitterButton.text() == "Start Auto Splitter" \ or "Delayed Split" in self.currentSplitImage.text() \ or (not self.undosplitButton.isEnabled() and not self.is_auto_controlled) \ or self.is_current_split_out_of_range(): @@ -545,7 +565,7 @@ def undoSplit(self): def skipSplit(self): # Can't skip or split until timer is started # or Splitting/skipping when there are no images left - if self.startautosplitterButton.text() == 'Start Auto Splitter' \ + if self.startautosplitterButton.text() == "Start Auto Splitter" \ or "Delayed Split" in self.currentSplitImage.text() \ or (not self.skipsplitButton.isEnabled() and not self.is_auto_controlled) \ or self.is_current_split_out_of_range(): @@ -569,12 +589,12 @@ def skipSplit(self): def reset(self): # When the reset button or hotkey is pressed, it will change this text, # which will trigger in the autoSplitter function, if running, to abort and change GUI. - self.startautosplitterButton.setText('Start Auto Splitter') + self.startautosplitterButton.setText("Start Auto Splitter") # Functions for the hotkeys to return to the main thread from signals and start their corresponding functions def startAutoSplitter(self): # If the auto splitter is already running or the button is disabled, don't emit the signal to start it. - if self.startautosplitterButton.text() == 'Running...' \ + if self.startautosplitterButton.text() == "Running..." \ or (not self.startautosplitterButton.isEnabled() and not self.is_auto_controlled): return @@ -596,7 +616,7 @@ def startPause(self): self.pauseSignal.emit() def checkForReset(self): - if self.startautosplitterButton.text() == 'Start Auto Splitter': + if self.startautosplitterButton.text() == "Start Auto Splitter": if self.autostartonresetCheckBox.isChecked(): self.startAutoSplitterSignal.emit() else: @@ -605,7 +625,7 @@ def checkForReset(self): return False def autoSplitter(self): - if not self.validateBeforeComparison(): + if not validateBeforeComparison(self): self.guiChangesOnReset() return @@ -634,7 +654,7 @@ def autoSplitter(self): in self.split_image_filenames] # construct a list of filenames, each filename copied with # of loops it has. - self.split_image_filenames_including_loops: List[str] = [] + self.split_image_filenames_including_loops: list[str] = [] for i, filename in enumerate(self.split_image_filenames): current_loop = 1 while split_image_loop_amount[i] >= current_loop: @@ -642,7 +662,7 @@ def autoSplitter(self): current_loop = current_loop + 1 # construct a list of corresponding loop number to the filenames - loop_numbers: List[int] = [] + loop_numbers: list[int] = [] loop_count = 1 for i, filename in enumerate(self.split_image_filenames_including_loops): if i == 0: @@ -661,9 +681,9 @@ def autoSplitter(self): ] # construct groups of splits if needed - self.split_groups: List[List[int]] = [] + self.split_groups: list[list[int]] = [] if self.groupDummySplitsCheckBox.isChecked(): - current_group: List[int] = [] + current_group: list[int] = [] self.split_groups.append(current_group) for i, image in enumerate(self.split_image_filenames_including_loops): @@ -724,7 +744,7 @@ def autoSplitter(self): capture, self.reset_mask) if reset_similarity >= self.reset_image_threshold: - self.send_command("reset") + send_command(self, "reset") self.reset() if self.checkForReset(): @@ -746,7 +766,7 @@ def autoSplitter(self): if self.showlivesimilarityCheckBox.isChecked(): self.livesimilarityLabel.setText(str(self.similarity)[:4]) else: - self.livesimilarityLabel.setText(' ') + self.livesimilarityLabel.setText(" ") # if the similarity becomes higher than highest similarity, set it as such. if self.similarity > self.highest_similarity: @@ -756,7 +776,7 @@ def autoSplitter(self): if self.showhighestsimilarityCheckBox.isChecked(): self.highestsimilarityLabel.setText(str(self.highest_similarity)[:4]) else: - self.highestsimilarityLabel.setText(' ') + self.highestsimilarityLabel.setText(" ") if not self.is_auto_controlled: # if its the last split image or can't skip due to grouped dummy splits, disable skip split button @@ -772,14 +792,14 @@ def autoSplitter(self): # then split on similarity below threshold. # if no b flag, just split when similarity goes above threshold. if not self.waiting_for_split_delay: - if self.flags & BELOW_FLAG == BELOW_FLAG and not self.split_below_threshold: - if self.similarity >= self.similarity_threshold: + if self.flags & BELOW_FLAG == BELOW_FLAG: + if self.split_below_threshold: + if self.similarity < self.similarity_threshold: + self.split_below_threshold = False + break + elif self.similarity >= self.similarity_threshold: self.split_below_threshold = True continue - elif self.flags & BELOW_FLAG == BELOW_FLAG and self.split_below_threshold: - if self.similarity < self.similarity_threshold: - self.split_below_threshold = False - break elif self.similarity >= self.similarity_threshold: break @@ -801,14 +821,14 @@ def autoSplitter(self): self.waiting_for_split_delay = True self.undosplitButton.setEnabled(False) self.skipsplitButton.setEnabled(False) - self.currentsplitimagefileLabel.setText(' ') + self.currentsplitimagefileLabel.setText(" ") # check for reset while delayed and display a counter of the remaining split delay time delay_start_time = time() split_delay = self.split_delay / 1000 while time() - delay_start_time < split_delay: delay_time_left = round(split_delay - (time() - delay_start_time), 1) - self.currentSplitImage.setText(f'Delayed Split: {delay_time_left} sec remaining') + self.currentSplitImage.setText(f"Delayed Split: {delay_time_left} sec remaining") # check for reset if not windowText: self.reset() @@ -825,7 +845,7 @@ def autoSplitter(self): capture, self.reset_mask) if reset_similarity >= self.reset_image_threshold: - self.send_command("reset") + send_command(self, "reset") self.reset() continue # Email sent to pyqt@riverbankcomputing.com @@ -834,7 +854,7 @@ def autoSplitter(self): self.waiting_for_split_delay = False # if {p} flag hit pause key, otherwise hit split hotkey - self.send_command("pause" if self.flags & PAUSE_FLAG == PAUSE_FLAG else "split") + send_command(self, "pause" if self.flags & PAUSE_FLAG == PAUSE_FLAG else "split") # if loop check box is checked and its the last split, go to first split. # else go to the next split image. @@ -864,12 +884,12 @@ def autoSplitter(self): # A pause loop to check if the user presses skip split, undo split, or reset here. # Also updates the current split image text, counting down the time until the next split image if self.pause > 0: - self.currentsplitimagefileLabel.setText(' ') - self.imageloopLabel.setText('Image Loop: -') + self.currentsplitimagefileLabel.setText(" ") + self.imageloopLabel.setText("Image Loop: -") pause_start_time = time() while time() - pause_start_time < self.pause: pause_time_left = round(self.pause - (time() - pause_start_time), 1) - self.currentSplitImage.setText(f'None (Paused). {pause_time_left} sec remaining') + self.currentSplitImage.setText(f"None (Paused). {pause_time_left} sec remaining") # check for reset if not windowText: @@ -891,7 +911,7 @@ def autoSplitter(self): capture, self.reset_mask) if reset_similarity >= self.reset_image_threshold: - self.send_command("reset") + send_command(self, "reset") self.reset() continue # Email sent to pyqt@riverbankcomputing.com @@ -902,7 +922,7 @@ def autoSplitter(self): def guiChangesOnStart(self): self.timerStartImage.stop() - self.startautosplitterButton.setText('Running...') + self.startautosplitterButton.setText("Running...") self.browseButton.setEnabled(False) self.groupDummySplitsCheckBox.setEnabled(False) self.startImageReloadButton.setEnabled(False) @@ -921,13 +941,13 @@ def guiChangesOnStart(self): QApplication.processEvents() def guiChangesOnReset(self): - self.startautosplitterButton.setText('Start Auto Splitter') - self.imageloopLabel.setText('Image Loop: -') - self.currentSplitImage.setText(' ') - self.currentsplitimagefileLabel.setText(' ') - self.livesimilarityLabel.setText(' ') - self.highestsimilarityLabel.setText(' ') - self.currentsimilaritythresholdnumberLabel.setText(' ') + self.startautosplitterButton.setText("Start Auto Splitter") + self.imageloopLabel.setText("Image Loop: -") + self.currentSplitImage.setText(" ") + self.currentsplitimagefileLabel.setText(" ") + self.livesimilarityLabel.setText(" ") + self.highestsimilarityLabel.setText(" ") + self.currentsimilaritythresholdnumberLabel.setText(" ") self.browseButton.setEnabled(True) self.groupDummySplitsCheckBox.setEnabled(True) self.startImageReloadButton.setEnabled(True) @@ -948,7 +968,7 @@ def guiChangesOnReset(self): def getCaptureForComparison(self): # grab screenshot of capture region - capture = capture_region(self.hwnd, self.selection) + capture = capture_region(self.hwnd, self.selection, self.forcePrintWindowCheckBox.isChecked()) capture = cv2.resize(capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST) # convert to BGR return cv2.cvtColor(capture, cv2.COLOR_BGRA2BGR) @@ -957,8 +977,8 @@ def shouldCheckResetImage(self): return self.reset_image is not None and time() - self.run_start_time > self.reset_image_pause_time def findResetImage(self): - self.reset_image: Optional[cv2.ndarray] = None - self.reset_mask: Optional[cv2.ndarray] = None + self.reset_image = None + self.reset_mask = None reset_image_file = None for image in self.split_image_filenames: @@ -1004,7 +1024,7 @@ def findResetImage(self): self.reset_image = cv2.imread(path, cv2.IMREAD_COLOR) self.reset_image = cv2.resize(self.reset_image, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST) - def updateSplitImage(self, custom_image_file: str = '', from_start_image: bool = False): + def updateSplitImage(self, custom_image_file: str = "", from_start_image: bool = False): # Splitting/skipping when there are no images left or Undoing past the first image # Start image is expected to be out of range (index 0 of 0-length array) if "START_AUTO_SPLITTER" not in custom_image_file.upper() and self.is_current_split_out_of_range(): @@ -1028,7 +1048,6 @@ def updateSplitImage(self, custom_image_file: str = '', from_start_image: bool = split_image_display = copy(self.split_image) # Transform transparency into UI's gray BG color transparent_mask = split_image_display[:, :, 3] == 0 - split_image_display[:, :, 3] == 0 split_image_display[transparent_mask] = [240, 240, 240, MAXBYTE] split_image_display = cv2.cvtColor(split_image_display, cv2.COLOR_BGRA2RGB) @@ -1089,7 +1108,7 @@ def updateSplitImage(self, custom_image_file: str = '', from_start_image: bool = def closeEvent(self, a0: Optional[QtGui.QCloseEvent] = None): # save global setting values here - self.setting_check_for_updates_on_open.setValue('check_for_updates_on_open', + self.setting_check_for_updates_on_open.setValue("check_for_updates_on_open", self.actionCheck_for_Updates_on_Open.isChecked()) def exitProgram(): @@ -1108,7 +1127,7 @@ def exitProgram(): if a0 is None: exitProgram() - if self.haveSettingsChanged(): + if settings.haveSettingsChanged(self): # Give a different warning if there was never a settings file that was loaded successfully, # and "save as" instead of "save". settings_file_name = "Untitled" \ @@ -1137,7 +1156,7 @@ def exitProgram(): def main(): app = QApplication(sys.argv) try: - app.setWindowIcon(QtGui.QIcon(':/resources/icon.ico')) + app.setWindowIcon(QtGui.QIcon(":/resources/icon.ico")) main_window = AutoSplit() main_window.show() # Needs to be after main_window.show() to be shown over @@ -1150,9 +1169,9 @@ def main(): timer.start(500) exit_code = app.exec() - except Exception as exception: + except Exception as exception: # pylint: disable=broad-except # Print error to console if not running in executable - if getattr(sys, 'frozen', False): + if getattr(sys, "frozen", False): error_messages.exceptionTraceback( f"AutoSplit encountered an unrecoverable exception and will now close. {CREATE_NEW_ISSUE_MESSAGE}", exception) @@ -1166,7 +1185,7 @@ def main(): sys.exit(exit_code) -def excepthook(exceptionType: Type[BaseException], exception: BaseException, _traceback: Optional[TracebackType]): +def excepthook(exceptionType: type[BaseException], exception: BaseException, _traceback: Optional[TracebackType]): # Catch Keyboard Interrupts for a clean close if exceptionType is KeyboardInterrupt: sys.exit(0) @@ -1176,6 +1195,6 @@ def excepthook(exceptionType: Type[BaseException], exception: BaseException, _tr exception) -if __name__ == '__main__': +if __name__ == "__main__": sys.excepthook = excepthook main() diff --git a/src/capture_windows.py b/src/capture_windows.py index cbcda017..2f6fe1aa 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -1,5 +1,5 @@ from __future__ import annotations -from typing import Dict, cast +from typing import cast import ctypes import ctypes.wintypes @@ -17,7 +17,7 @@ # This is an undocumented nFlag value for PrintWindow PW_RENDERFULLCONTENT = 0x00000002 -accelerated_windows: Dict[int, bool] = {} +accelerated_windows: dict[int, bool] = {} is_windows_11 = version.parse(platform.version()) >= version.parse("10.0.22000") @@ -30,7 +30,7 @@ class Rect(ctypes.wintypes.RECT): bottom: int = -1 # type: ignore -def capture_region(hwnd: int, selection: Rect): +def capture_region(hwnd: int, selection: Rect, forcePrintWindow: bool): """ Captures an image of the region for a window matching the given parameters of the bounding box @@ -42,7 +42,7 @@ def capture_region(hwnd: int, selection: Rect): # Windows 11 has some jank, and we're not ready to fully investigate it # for now let's ensure it works at the cost of performance - is_accelerated_window = is_windows_11 or accelerated_windows.get(hwnd) + is_accelerated_window = forcePrintWindow or is_windows_11 or accelerated_windows.get(hwnd) # The window type is not yet known, let's find out! if is_accelerated_window is None: @@ -79,7 +79,7 @@ def __get_image(hwnd: int, selection: Rect, print_window: bool = False): except (win32ui.error, pywintypes.error): # type: ignore return np.array([0, 0, 0, 1], dtype="uint8") - image: cv2.ndarray = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype='uint8') + image: cv2.ndarray = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype="uint8") image.shape = (height, width, 4) try: diff --git a/src/compare.py b/src/compare.py index c2cd9243..7faae841 100644 --- a/src/compare.py +++ b/src/compare.py @@ -12,7 +12,12 @@ ranges = [0, MAXRANGE, 0, MAXRANGE, 0, MAXRANGE] -def compareImage(comparisonMethod: int, image: Optional[cv2.ndarray], capture: Optional[cv2.ndarray], mask: Optional[cv2.ndarray] = None): +def compareImage( + comparisonMethod: int, + image: Optional[cv2.ndarray], + capture: Optional[cv2.ndarray], + mask: Optional[cv2.ndarray] = None +): if image is None or capture is None: return 0.0 if comparisonMethod == 0: @@ -47,7 +52,6 @@ def compare_histograms(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional def compare_l2_norm(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv2.ndarray] = None): """ Compares two images by calculating the L2 Error (square-root of sum of squared error) - @param source: Image of any given shape @param capture: Image matching the dimensions of the source @param mask: An image matching the dimensions of the source, but 1 channel grayscale @@ -118,7 +122,7 @@ def compare_phash(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv2. return 1 - (hash_diff / 64.0) -def checkIfImageHasTransparency(image: cv2.ndarray): +def checkIfImageHasTransparency(image: cv2.ndarray) -> bool: # Check if there's a transparency channel (4th channel) and if at least one pixel is transparent (< 255) if image.shape[2] != 4: return False diff --git a/src/error_messages.py b/src/error_messages.py index 740ee14f..bad19bd9 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -3,9 +3,9 @@ from PyQt6 import QtCore, QtWidgets -def setTextMessage(message: str, details: str = ''): +def setTextMessage(message: str, details: str = ""): messageBox = QtWidgets.QMessageBox() - messageBox.setWindowTitle('Error') + messageBox.setWindowTitle("Error") messageBox.setTextFormat(QtCore.Qt.TextFormat.RichText) messageBox.setText(message) if details: @@ -30,7 +30,7 @@ def splitImageDirectoryEmpty(): def imageTypeError(image: str): - setTextMessage(f"\"{image}\" is not a valid image file, does not exist, " + setTextMessage(f'"{image}" is not a valid image file, does not exist, ' "or the full image file path contains a special character.") @@ -57,11 +57,11 @@ def alignmentNotMatchedError(): def noKeywordImageError(keyword: str): - setTextMessage(f"Your split image folder does not contain an image with the keyword \"{keyword}\".") + setTextMessage(f'Your split image folder does not contain an image with the keyword "{keyword}".') def multipleKeywordImagesError(keyword: str): - setTextMessage(f"Only one image with the keyword \"{keyword}\" is allowed.") + setTextMessage(f'Only one image with the keyword "{keyword}" is allowed.') def resetHotkeyError(): @@ -95,7 +95,8 @@ def checkForUpdatesError(): def loadStartImageError(): - setTextMessage("Start Image found, but cannot be loaded unless Start, Reset, and Pause hotkeys are set. Please set these hotkeys, and then click the Reload Start Image button.") + setTextMessage("Start Image found, but cannot be loaded unless Start, Reset, and Pause hotkeys are set. " + "Please set these hotkeys, and then click the Reload Start Image button.") def stdinLostError(): diff --git a/src/gen/about.pyi b/src/gen/about.pyi index 786170bc..c686e0ea 100644 --- a/src/gen/about.pyi +++ b/src/gen/about.pyi @@ -1,6 +1,6 @@ from PyQt6.QtWidgets import QWidget -class Ui_aboutAutoSplitWidget(object): +class Ui_aboutAutoSplitWidget(): def setupUi(self, aboutAutoSplitWidget: QWidget) -> None: ... diff --git a/src/gen/design.pyi b/src/gen/design.pyi index d999d224..6d951853 100644 --- a/src/gen/design.pyi +++ b/src/gen/design.pyi @@ -1,6 +1,6 @@ from PyQt6.QtWidgets import QMainWindow -class Ui_MainWindow(object): +class Ui_MainWindow(): def setupUi(self, MainWindow: QMainWindow) -> None: ... diff --git a/src/gen/update_checker.pyi b/src/gen/update_checker.pyi index c3680370..027afe46 100644 --- a/src/gen/update_checker.pyi +++ b/src/gen/update_checker.pyi @@ -1,6 +1,6 @@ from PyQt6.QtWidgets import QWidget -class Ui_UpdateChecker(object): +class Ui_UpdateChecker(): def setupUi(self, UpdateChecker: QWidget) -> None: ... diff --git a/src/hotkeys.py b/src/hotkeys.py index 56d773b3..b586272b 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -1,5 +1,6 @@ from __future__ import annotations -from typing import Optional, Callable, TYPE_CHECKING, Union +from typing import Optional, TYPE_CHECKING, Union +from collections.abc import Callable if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -24,11 +25,11 @@ def beforeSettingHotkey(autosplit: AutoSplit): # do all of these things after you set a hotkey. a signal connects to this because # changing GUI stuff in the hotkey thread was causing problems def afterSettingHotkey(autosplit: AutoSplit): - autosplit.setsplithotkeyButton.setText('Set Hotkey') - autosplit.setresethotkeyButton.setText('Set Hotkey') - autosplit.setskipsplithotkeyButton.setText('Set Hotkey') - autosplit.setundosplithotkeyButton.setText('Set Hotkey') - autosplit.setpausehotkeyButton.setText('Set Hotkey') + autosplit.setsplithotkeyButton.setText("Set Hotkey") + autosplit.setresethotkeyButton.setText("Set Hotkey") + autosplit.setskipsplithotkeyButton.setText("Set Hotkey") + autosplit.setundosplithotkeyButton.setText("Set Hotkey") + autosplit.setpausehotkeyButton.setText("Set Hotkey") autosplit.startautosplitterButton.setEnabled(True) autosplit.setsplithotkeyButton.setEnabled(True) autosplit.setresethotkeyButton.setEnabled(True) @@ -49,15 +50,14 @@ def is_digit(key: Optional[str]): def send_command(autosplit: AutoSplit, command: str): if autosplit.is_auto_controlled: print(command, flush=True) + elif command in {"split", "start"}: + _send_hotkey(autosplit.splitLineEdit.text()) + elif command == "pause": + _send_hotkey(autosplit.pausehotkeyLineEdit.text()) + elif command == "reset": + _send_hotkey(autosplit.resetLineEdit.text()) else: - if command in ("split", "start"): - _send_hotkey(autosplit.splitLineEdit.text()) - elif command == "pause": - _send_hotkey(autosplit.pausehotkeyLineEdit.text()) - elif command == "reset": - _send_hotkey(autosplit.resetLineEdit.text()) - else: - raise KeyError(f"'{command}' is not a valid LiveSplit.AutoSplitIntegration command") + raise KeyError(f"'{command}' is not a valid LiveSplit.AutoSplitIntegration command") # Supports sending the appropriate scan code for all the special cases @@ -67,20 +67,19 @@ def _send_hotkey(key_or_scan_code: Union[int, str]): # Deal with regular inputs if isinstance(key_or_scan_code, int) \ - or not (key_or_scan_code.startswith('num ') or key_or_scan_code == 'decimal'): + or not (key_or_scan_code.startswith("num ") or key_or_scan_code == "decimal"): keyboard.send(key_or_scan_code) - keyboard.key_to_scan_codes return - # Deal with problematic keys. Even by sending specific scan code 'keyboard' still sends the default (wrong) key + # Deal with problematic keys. Even by sending specific scan code "keyboard" still sends the default (wrong) key # keyboard.send(keyboard.key_to_scan_codes(key_or_scan_code)[1]) - pyautogui.hotkey(key_or_scan_code.replace(' ', '')) + pyautogui.hotkey(key_or_scan_code.replace(" ", "")) def __validate_keypad(expected_key: str, keyboard_event: KeyboardEvent) -> bool: # Prevent "(keypad)delete", "(keypad)./decimal" and "del" from triggering each other # as well as "." and "(keypad)./decimal" - if keyboard_event.scan_code in (83, 52): + if keyboard_event.scan_code in {83, 52}: # TODO: "del" won't work with "(keypad)delete" if localized in non-english (ie: "suppr" in french) return expected_key == keyboard_event.name # Prevent "action keys" from triggering "keypad keys" @@ -99,11 +98,11 @@ def __validate_keypad(expected_key: str, keyboard_event: KeyboardEvent) -> bool: # Windows reports different physical keys with the same scan code. # For example, "Home", "Num Home" and "Num 7" are all "71". # See: https://github.com/boppreh/keyboard/issues/171#issuecomment-390437684 -# + # We're doing the check here instead of saving the key code because it'll # cause issues with save files and the non-keypad shared keys are localized # while the keypad ones aren't. -# + # Since we reuse the key string we set to send to LiveSplit, we can't use fake names like "num home". # We're also trying to achieve the same hotkey behaviour as LiveSplit has. def _hotkey_action(keyboard_event: KeyboardEvent, key_name: str, action: Callable[[], None]): @@ -129,10 +128,10 @@ def __is_key_already_set(autosplit: AutoSplit, key_name: str): # TODO: Refactor to de-duplicate all this code, including settings_file.py # Going to comment on one func, and others will be similar. def setSplitHotkey(autosplit: AutoSplit): - autosplit.setsplithotkeyButton.setText('Press a key...') + autosplit.setsplithotkeyButton.setText("Press a key...") # disable some buttons - autosplit.beforeSettingHotkey() + beforeSettingHotkey(autosplit) # new thread points to callback. this thread is needed or GUI will freeze # while the program waits for user input on the hotkey @@ -163,7 +162,7 @@ def callback(hotkey: Callable[[], None]): # hotkey. A try and except is needed if a hotkey hasn't been set yet. I'm not # allowing for these multiple-key hotkeys because it can cause crashes, and # not many people are going to really use or need this. - if __is_key_already_set(autosplit, key_name) or (key_name != '+' and '+' in key_name): + if __is_key_already_set(autosplit, key_name) or (key_name != "+" and "+" in key_name): autosplit.afterSettingHotkeySignal.emit() return except AttributeError: @@ -189,8 +188,8 @@ def callback(hotkey: Callable[[], None]): def setResetHotkey(autosplit: AutoSplit): - autosplit.setresethotkeyButton.setText('Press a key...') - autosplit.beforeSettingHotkey() + autosplit.setresethotkeyButton.setText("Press a key...") + beforeSettingHotkey(autosplit) def callback(hotkey: Callable[[], None]): try: @@ -201,7 +200,7 @@ def callback(hotkey: Callable[[], None]): key_name = __get_key_name(keyboard.read_event(True)) try: - if __is_key_already_set(autosplit, key_name) or (key_name != '+' and '+' in key_name): + if __is_key_already_set(autosplit, key_name) or (key_name != "+" and "+" in key_name): autosplit.afterSettingHotkeySignal.emit() return except AttributeError: @@ -220,8 +219,8 @@ def callback(hotkey: Callable[[], None]): def setSkipSplitHotkey(autosplit: AutoSplit): - autosplit.setskipsplithotkeyButton.setText('Press a key...') - autosplit.beforeSettingHotkey() + autosplit.setskipsplithotkeyButton.setText("Press a key...") + beforeSettingHotkey(autosplit) def callback(hotkey: Callable[[], None]): try: @@ -232,7 +231,7 @@ def callback(hotkey: Callable[[], None]): key_name = __get_key_name(keyboard.read_event(True)) try: - if __is_key_already_set(autosplit, key_name) or (key_name != '+' and '+' in key_name): + if __is_key_already_set(autosplit, key_name) or (key_name != "+" and "+" in key_name): autosplit.afterSettingHotkeySignal.emit() return except AttributeError: @@ -251,8 +250,8 @@ def callback(hotkey: Callable[[], None]): def setUndoSplitHotkey(autosplit: AutoSplit): - autosplit.setundosplithotkeyButton.setText('Press a key...') - autosplit.beforeSettingHotkey() + autosplit.setundosplithotkeyButton.setText("Press a key...") + beforeSettingHotkey(autosplit) def callback(hotkey: Callable[[], None]): try: @@ -263,7 +262,7 @@ def callback(hotkey: Callable[[], None]): key_name = __get_key_name(keyboard.read_event(True)) try: - if __is_key_already_set(autosplit, key_name) or (key_name != '+' and '+' in key_name): + if __is_key_already_set(autosplit, key_name) or (key_name != "+" and "+" in key_name): autosplit.afterSettingHotkeySignal.emit() return except AttributeError: @@ -282,8 +281,8 @@ def callback(hotkey: Callable[[], None]): def setPauseHotkey(autosplit: AutoSplit): - autosplit.setpausehotkeyButton.setText('Press a key...') - autosplit.beforeSettingHotkey() + autosplit.setpausehotkeyButton.setText("Press a key...") + beforeSettingHotkey(autosplit) def callback(hotkey: Callable[[], None]): try: @@ -294,7 +293,7 @@ def callback(hotkey: Callable[[], None]): key_name = __get_key_name(keyboard.read_event(True)) try: - if __is_key_already_set(autosplit, key_name) or (key_name != '+' and '+' in key_name): + if __is_key_already_set(autosplit, key_name) or (key_name != "+" and "+" in key_name): autosplit.afterSettingHotkeySignal.emit() return except AttributeError: diff --git a/src/menu_bar.py b/src/menu_bar.py index 7042e290..cf67f09d 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -53,7 +53,7 @@ def __init__(self, latest_version: str, autosplit: AutoSplit, check_for_updates_ def openUpdate(self): if self.checkBoxDoNotAskMeAgain.isChecked(): self.autosplit.actionCheck_for_Updates_on_Open.setChecked(False) - os.system("start \"\" https://github.com/Toufool/Auto-Split/releases/latest") + os.system('start "" https://github.com/Toufool/Auto-Split/releases/latest') self.close() def closeWindow(self): @@ -63,7 +63,7 @@ def closeWindow(self): def viewHelp(): - os.system("start \"\" https://github.com/Toufool/Auto-Split#tutorial") + os.system('start "" https://github.com/Toufool/Auto-Split#tutorial') def about(autosplit: AutoSplit): @@ -74,7 +74,7 @@ def checkForUpdates(autosplit: AutoSplit, check_for_updates_on_open: bool = Fals try: response = requests.get("https://api.github.com/repos/Toufool/Auto-Split/releases/latest") latest_version = response.json()["name"].split("v")[1] - except Exception: + except requests.exceptions.RequestException: if not check_for_updates_on_open: error_messages.checkForUpdatesError() else: diff --git a/src/screen_region.py b/src/screen_region.py index 05fceb50..88c4ae3f 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -1,5 +1,5 @@ from __future__ import annotations -from typing import Tuple, cast, TYPE_CHECKING +from typing import cast, TYPE_CHECKING if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -84,12 +84,12 @@ def selectWindow(autosplit: AutoSplit): # Need to wait until the user has selected a region using the widget before moving on with # selecting the window settings - while selector.x == -1 and selector.y == -1: + while selector.x() == -1 and selector.y() == -1: # Email sent to pyqt@riverbankcomputing.com QtTest.QTest.qWait(1) # type: ignore # Grab the window handle from the coordinates selected by the widget - autosplit.hwnd = cast(int, win32gui.WindowFromPoint((selector.x, selector.y))) + autosplit.hwnd = cast(int, win32gui.WindowFromPoint((selector.x(), selector.y()))) del selector @@ -111,7 +111,7 @@ def selectWindow(autosplit: AutoSplit): # also the top bar with the window name is not accounted for # I hardcoded the x and y coordinates to fix this # This is not an ideal solution because it assumes every window will have a top bar - selection: Tuple[int, int, int, int] = win32gui.GetClientRect(autosplit.hwnd) + selection: tuple[int, int, int, int] = win32gui.GetClientRect(autosplit.hwnd) autosplit.selection.left = 8 autosplit.selection.top = 31 autosplit.selection.right = 8 + selection[2] @@ -151,7 +151,10 @@ def alignRegion(autosplit: AutoSplit): # Obtaining the capture of a region which contains the # subregion being searched for to align the image. - capture = capture_windows.capture_region(autosplit.hwnd, autosplit.selection) + capture = capture_windows.capture_region( + autosplit.hwnd, + autosplit.selection, + autosplit.forcePrintWindowCheckBox.isChecked()) capture = cv2.cvtColor(capture, cv2.COLOR_BGRA2BGR) # Obtain the best matching point for the template within the @@ -235,7 +238,7 @@ def __init__(self): user32.GetSystemMetrics(SM_YVIRTUALSCREEN), user32.GetSystemMetrics(SM_CXVIRTUALSCREEN), user32.GetSystemMetrics(SM_CYVIRTUALSCREEN)) - self.setWindowTitle(' ') + self.setWindowTitle(" ") self.setWindowOpacity(0.5) self.setWindowFlags(QtCore.Qt.WindowType.FramelessWindowHint) self.show() @@ -247,9 +250,18 @@ def keyPressEvent(self, a0: QtGui.QKeyEvent): # Widget to select a window and obtain its bounds class SelectWindowWidget(BaseSelectWidget): + __x = -1 + __y = -1 + + def x(self): + return self.__x + + def y(self): + return self.__y + def mouseReleaseEvent(self, a0: QtGui.QMouseEvent): - self.x = lambda: int(a0.position().x()) + self.geometry().x() - self.y = lambda: int(a0.position().y()) + self.geometry().y() + self.__x = int(a0.position().x()) + self.geometry().x() + self.__y = int(a0.position().y()) + self.geometry().y() self.close() @@ -276,8 +288,8 @@ def width(self): def paintEvent(self, a0: QtGui.QPaintEvent): if self.__begin != self.__end: qPainter = QtGui.QPainter(self) - qPainter.setPen(QtGui.QPen(QtGui.QColor('red'), 2)) - qPainter.setBrush(QtGui.QColor('opaque')) + qPainter.setPen(QtGui.QPen(QtGui.QColor("red"), 2)) + qPainter.setBrush(QtGui.QColor("opaque")) qPainter.drawRect(QtCore.QRect(self.__begin, self.__end)) def mousePressEvent(self, a0: QtGui.QMouseEvent): diff --git a/src/settings_file.py b/src/settings_file.py index 0391405e..55636563 100644 --- a/src/settings_file.py +++ b/src/settings_file.py @@ -1,5 +1,5 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any, List, Literal, cast +from typing import TYPE_CHECKING, Any, Literal, cast if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -11,17 +11,24 @@ from PyQt6 import QtWidgets import error_messages -from hotkeys import _hotkey_action +# TODO with settings refactoring +from hotkeys import _hotkey_action # type: ignore # Get the directory of either AutoSplit.exe or AutoSplit.py -auto_split_directory = os.path.dirname(sys.executable if getattr(sys, 'frozen', False) else os.path.abspath(__file__)) +auto_split_directory = os.path.dirname(sys.executable if getattr(sys, "frozen", False) else os.path.abspath(__file__)) + + +class RestrictedUnpickler(pickle.Unpickler): + + def find_class(self, module: str, name: str): + raise pickle.UnpicklingError("'%s.%s' is forbidden" % (module, name)) def loadPyQtSettings(autosplit: AutoSplit): # These are only global settings values. They are not *pkl settings values. autosplit.getGlobalSettingsValues() check_for_updates_on_open = autosplit.setting_check_for_updates_on_open.value( - 'check_for_updates_on_open', + "check_for_updates_on_open", True, type=bool) autosplit.actionCheck_for_Updates_on_Open.setChecked(check_for_updates_on_open) @@ -29,10 +36,6 @@ def loadPyQtSettings(autosplit: AutoSplit): def getSaveSettingsValues(autosplit: AutoSplit): # get values to be able to save settings - autosplit.x = autosplit.xSpinBox.value() - autosplit.y = autosplit.ySpinBox.value() - autosplit.width = autosplit.widthSpinBox.value() - autosplit.height = autosplit.heightSpinBox.value() autosplit.similarity_threshold = autosplit.similaritythresholdDoubleSpinBox.value() autosplit.comparison_index = autosplit.comparisonmethodComboBox.currentIndex() autosplit.pause = autosplit.pauseDoubleSpinBox.value() @@ -54,7 +57,7 @@ def getSaveSettingsValues(autosplit: AutoSplit): def haveSettingsChanged(autosplit: AutoSplit): - autosplit.getSaveSettingsValues() + getSaveSettingsValues(autosplit) current_save_settings = [ autosplit.split_image_directory, autosplit.similarity_threshold, @@ -66,16 +69,17 @@ def haveSettingsChanged(autosplit: AutoSplit): autosplit.skip_split_key, autosplit.undo_split_key, autosplit.pause_key, - autosplit.x, - autosplit.y, - autosplit.width, - autosplit.height, + autosplit.xSpinBox.value(), + autosplit.ySpinBox.value(), + autosplit.widthSpinBox.value(), + autosplit.heightSpinBox.value(), autosplit.hwnd_title, 0, 0, autosplit.group_dummy_splits_undo_skip_setting, autosplit.loop_setting, - autosplit.auto_start_on_reset_setting] + autosplit.auto_start_on_reset_setting, + autosplit.forcePrintWindowCheckBox.isChecked()] # One small caveat in this: if you load a settings file from an old version, but dont change settings, # the current save settings and last load settings will have different # of elements and it will ask @@ -85,9 +89,9 @@ def haveSettingsChanged(autosplit: AutoSplit): def saveSettings(autosplit: AutoSplit): if not autosplit.last_successfully_loaded_settings_file_path: - autosplit.saveSettingsAs() + saveSettingsAs(autosplit) else: - autosplit.getSaveSettingsValues() + getSaveSettingsValues(autosplit) autosplit.last_saved_settings = [ autosplit.split_image_directory, autosplit.similarity_threshold, @@ -99,18 +103,19 @@ def saveSettings(autosplit: AutoSplit): autosplit.skip_split_key, autosplit.undo_split_key, autosplit.pause_key, - autosplit.x, - autosplit.y, - autosplit.width, - autosplit.height, + autosplit.xSpinBox.value(), + autosplit.ySpinBox.value(), + autosplit.widthSpinBox.value(), + autosplit.heightSpinBox.value(), autosplit.hwnd_title, 0, 0, autosplit.group_dummy_splits_undo_skip_setting, autosplit.loop_setting, - autosplit.auto_start_on_reset_setting] + autosplit.auto_start_on_reset_setting, + autosplit.forcePrintWindowCheckBox.isChecked()] # save settings to a .pkl file - with open(autosplit.last_successfully_loaded_settings_file_path, 'wb') as f: + with open(autosplit.last_successfully_loaded_settings_file_path, "wb") as f: pickle.dump(autosplit.last_saved_settings, f) @@ -126,7 +131,7 @@ def saveSettingsAs(autosplit: AutoSplit): if not autosplit.save_settings_file_path: return - autosplit.getSaveSettingsValues() + getSaveSettingsValues(autosplit) autosplit.last_saved_settings = [ autosplit.split_image_directory, autosplit.similarity_threshold, @@ -138,19 +143,20 @@ def saveSettingsAs(autosplit: AutoSplit): autosplit.skip_split_key, autosplit.undo_split_key, autosplit.pause_key, - autosplit.x, - autosplit.y, - autosplit.width, - autosplit.height, + autosplit.xSpinBox.value(), + autosplit.ySpinBox.value(), + autosplit.widthSpinBox.value(), + autosplit.heightSpinBox.value(), autosplit.hwnd_title, 0, 0, autosplit.group_dummy_splits_undo_skip_setting, autosplit.loop_setting, - autosplit.auto_start_on_reset_setting] + autosplit.auto_start_on_reset_setting, + autosplit.forcePrintWindowCheckBox.isChecked()] # save settings to a .pkl file - with open(autosplit.save_settings_file_path, 'wb') as f: + with open(autosplit.save_settings_file_path, "wb") as f: pickle.dump(autosplit.last_saved_settings, f) # Wording is kinda off here but this needs to be here for an edge case: @@ -188,19 +194,23 @@ def loadSettings(autosplit: AutoSplit, load_settings_on_open: bool = False, load return try: - with open(autosplit.load_settings_file_path, 'rb') as f: - settings: List[Any] = pickle.load(f) + with open(autosplit.load_settings_file_path, "rb") as f: + settings: list[Any] = RestrictedUnpickler(f).load() settings_count = len(settings) if settings_count < 18: autosplit.showErrorSignal.emit(error_messages.oldVersionSettingsFileError) return # v1.3-1.4 settings. Add default pause_key and auto_start_on_reset_setting if settings_count == 18: - settings.insert(9, '') + settings.insert(9, "") settings.insert(20, 0) # v1.5 settings - elif settings_count != 20: - autosplit.showErrorSignal.emit(error_messages.invalidSettingsError) + if settings_count == 20: + settings.insert(21, False) + # v1.6.X settings + elif settings_count != 21: + if not load_settings_from_livesplit: + autosplit.showErrorSignal.emit(error_messages.invalidSettingsError) return autosplit.last_loaded_settings = [ autosplit.split_image_directory, @@ -213,17 +223,21 @@ def loadSettings(autosplit: AutoSplit, load_settings_on_open: bool = False, load autosplit.skip_split_key, autosplit.undo_split_key, autosplit.pause_key, - autosplit.x, - autosplit.y, - autosplit.width, - autosplit.height, + region_x, + region_y, + region_width, + region_height, autosplit.hwnd_title, _, _, autosplit.group_dummy_splits_undo_skip_setting, autosplit.loop_setting, - autosplit.auto_start_on_reset_setting] = settings - except (FileNotFoundError, MemoryError, pickle.UnpicklingError): + autosplit.auto_start_on_reset_setting, + forcePrintWindowCheckBox] = settings + + autosplit.forcePrintWindowCheckBox.setChecked(forcePrintWindowCheckBox) + except (FileNotFoundError, MemoryError, pickle.UnpicklingError) as e: + print(e) autosplit.showErrorSignal.emit(error_messages.invalidSettingsError) return @@ -231,10 +245,10 @@ def loadSettings(autosplit: AutoSplit, load_settings_on_open: bool = False, load autosplit.similaritythresholdDoubleSpinBox.setValue(autosplit.similarity_threshold) autosplit.pauseDoubleSpinBox.setValue(autosplit.pause) autosplit.fpslimitSpinBox.setValue(autosplit.fps_limit) - autosplit.xSpinBox.setValue(autosplit.x) - autosplit.ySpinBox.setValue(autosplit.y) - autosplit.widthSpinBox.setValue(autosplit.width) - autosplit.heightSpinBox.setValue(autosplit.height) + autosplit.xSpinBox.setValue(region_x) + autosplit.ySpinBox.setValue(region_y) + autosplit.widthSpinBox.setValue(region_width) + autosplit.heightSpinBox.setValue(region_height) autosplit.comparisonmethodComboBox.setCurrentIndex(autosplit.comparison_index) # https://github.com/kaluluosi/pywin32-stubs/issues/7 autosplit.hwnd = win32gui.FindWindow(None, autosplit.hwnd_title) # type: ignore diff --git a/src/split_parser.py b/src/split_parser.py index 1932878c..5e24c78a 100644 --- a/src/split_parser.py +++ b/src/split_parser.py @@ -1,9 +1,11 @@ -import os -from typing import List +from __future__ import annotations +from typing import TYPE_CHECKING +if TYPE_CHECKING: + from AutoSplit import AutoSplit +import os import cv2 -from AutoSplit import AutoSplit import error_messages @@ -27,8 +29,8 @@ def threshold_from_filename(filename: str): # Check to make sure there is a valid floating point number between # parentheses of the filename try: - threshold = float(filename.split('(', 1)[1].split(')')[0]) - except Exception: + threshold = float(filename.split("(", 1)[1].split(")")[0]) + except (IndexError, ValueError): return None # Check to make sure if it is a valid threshold @@ -47,8 +49,8 @@ def pause_from_filename(filename: str): # Check to make sure there is a valid pause time between brackets # of the filename try: - pause = float(filename.split('[', 1)[1].split(']')[0]) - except Exception: + pause = float(filename.split("[", 1)[1].split("]")[0]) + except (IndexError, ValueError): return None # Pause times should always be positive or zero @@ -67,8 +69,8 @@ def delay_from_filename(filename: str): # Check to make sure there is a valid delay time between brackets # of the filename try: - delay = float(filename.split('#', 1)[1].split('#')[0]) - except Exception: + delay = float(filename.split("#", 1)[1].split("#")[0]) + except (IndexError, ValueError): return 0.0 # Delay times should always be positive or zero @@ -87,8 +89,8 @@ def loop_from_filename(filename: str): # Check to make sure there is a valid delay time between brackets # of the filename try: - loop = int(filename.split('@', 1)[1].split('@')[0]) - except Exception: + loop = int(filename.split("@", 1)[1].split("@")[0]) + except (IndexError, ValueError): return 1 # Loop should always be positive @@ -102,29 +104,29 @@ def flags_from_filename(filename: str): @param filename: String containing the file's name @return: The flags as an integer, if invalid flags are found it returns 0 - List of flags: - 'd' = dummy, do nothing when this split is found - 'b' = below threshold, after threshold is met, split when it goes below the threhsold. - 'p' = pause, hit pause key when this split is found + list of flags: + "d" = dummy, do nothing when this split is found + "b" = below threshold, after threshold is met, split when it goes below the threhsold. + "p" = pause, hit pause key when this split is found """ # Check to make sure there are flags between curly braces # of the filename try: - flags_str = filename.split('{', 1)[1].split('}')[0] - except Exception: + flags_str = filename.split("{", 1)[1].split("}")[0] + except (IndexError, ValueError): return 0 flags = 0x00 for c in flags_str: - if c.upper() == 'D': + if c.upper() == "D": flags |= DUMMY_FLAG - elif c.upper() == 'M': + elif c.upper() == "M": flags |= MASK_FLAG - elif c.upper() == 'B': + elif c.upper() == "B": flags |= BELOW_FLAG - elif c.upper() == 'P': + elif c.upper() == "P": flags |= PAUSE_FLAG else: # An invalid flag was caught, this filename was written incorrectly @@ -146,7 +148,7 @@ def is_reset_image(filename: str): @param filename: String containing the file's name @return: True if its a reset image """ - return 'RESET' in filename.upper() + return "RESET" in filename.upper() def is_start_auto_splitter_image(filename: str): @@ -156,10 +158,10 @@ def is_start_auto_splitter_image(filename: str): @param filename: String containing the file's name @return: True if its a reset image """ - return 'START_AUTO_SPLITTER' in filename.upper() + return "START_AUTO_SPLITTER" in filename.upper() -def removeStartAutoSplitterImage(split_image_filenames: List[str]): +def removeStartAutoSplitterImage(split_image_filenames: list[str]): start_auto_splitter_image_file = None for image in split_image_filenames: if is_start_auto_splitter_image(image): @@ -207,7 +209,7 @@ def validate_images_before_parsing(autosplit: AutoSplit): return if already_found_reset_image: autosplit.guiChangesOnReset() - error_messages.multipleKeywordImagesError('reset') + error_messages.multipleKeywordImagesError("reset") return already_found_reset_image = True @@ -215,6 +217,6 @@ def validate_images_before_parsing(autosplit: AutoSplit): if is_start_auto_splitter_image(image): if already_found_start_image: autosplit.guiChangesOnReset() - error_messages.multipleKeywordImagesError('start_auto_splitter') + error_messages.multipleKeywordImagesError("start_auto_splitter") return already_found_start_image = True diff --git a/typings/win32helper/win32con.pyi b/typings/win32con/__init__.pyi similarity index 99% rename from typings/win32helper/win32con.pyi rename to typings/win32con/__init__.pyi index 4c3a0fef..92e62fdc 100644 --- a/typings/win32helper/win32con.pyi +++ b/typings/win32con/__init__.pyi @@ -1,3 +1,7 @@ +""" +This type stub file was generated by pyright. +""" + # Generated by h2py from commdlg.h (plus modifications 4jan98) WINVER = 1280 WM_USER = 1024 diff --git a/typings/win32helper/win32typing.pyi b/typings/win32typing/__init__.pyi similarity index 96% rename from typings/win32helper/win32typing.pyi rename to typings/win32typing/__init__.pyi index ff7cdbae..f11a35e4 100644 --- a/typings/win32helper/win32typing.pyi +++ b/typings/win32typing/__init__.pyi @@ -1,3 +1,7 @@ +""" +This type stub file was generated by pyright. +""" + __all__=['', 'COMMTIMEOUTS', 'CopyProgressRoutine', 'DOCINFO', 'ExportCallback', 'FORM_INFO_1', 'ImportCallback', 'LARGE_INTEGER', 'NCB', 'PRINTER_DEFAULTS', 'PyACL', 'PyBITMAP', 'PyBLENDFUNCTION', 'PyCEHANDLE', 'PyCERTSTORE', 'PyCERT_ALT_NAME_ENTRY', 'PyCERT_ALT_NAME_INFO', 'PyCERT_AUTHORITY_KEY_ID_INFO', 'PyCERT_BASIC_CONSTRAINTS2_INFO', 'PyCERT_BASIC_CONSTRAINTS_INFO', 'PyCERT_CONTEXT', 'PyCERT_EXTENSION', 'PyCERT_KEY_ATTRIBUTES_INFO', 'PyCERT_NAME_INFO', 'PyCERT_NAME_VALUE', 'PyCERT_OTHER_NAME', 'PyCERT_POLICY_INFO', 'PyCERT_PUBLIC_KEY_INFO', 'PyCOMSTAT', 'PyCOORD', 'PyCREDENTIAL', 'PyCREDENTIAL_ATTRIBUTE', 'PyCREDENTIAL_TARGET_INFORMATION', 'PyCREDUI_INFO', 'PyCRYPTHASH', 'PyCRYPTKEY', 'PyCRYPTMSG', 'PyCRYPTPROTECT_PROMPTSTRUCT', 'PyCRYPTPROV', 'PyCRYPT_ALGORITHM_IDENTIFIER', 'PyCRYPT_ATTRIBUTE', 'PyCRYPT_BIT_BLOB', 'PyCRYPT_DECRYPT_MESSAGE_PARA', 'PyCRYPT_ENCRYPT_MESSAGE_PARA', 'PyCRYPT_SIGN_MESSAGE_PARA', 'PyCRYPT_VERIFY_MESSAGE_PARA', 'PyCTL_CONTEXT', 'PyCTL_USAGE', 'PyConsoleScreenBuffer', 'PyCredHandle', 'PyCtxtHandle', 'PyDCB', 'PyDEVMODE', 'PyDEVMODEW', 'PyDISPLAY_DEVICE', 'PyDLGITEMTEMPLATE', 'PyDLGTEMPLATE', 'PyDS_HANDLE', 'PyDS_NAME_RESULT_ITEM', 'PyDateTime', 'PyDialogTemplate', 'PyEVTLOG_HANDLE', 'PyEVT_HANDLE', 'PyEVT_RPC_LOGIN', 'PyEventLogRecord', 'PyGROUP_INFO_0', 'PyGROUP_INFO_1', 'PyGROUP_INFO_1002', 'PyGROUP_INFO_1005', 'PyGROUP_INFO_2', 'PyGROUP_USERS_INFO_0', 'PyGROUP_USERS_INFO_1', 'PyGdiHANDLE', 'PyGetSignerCertificate', 'PyHANDLE', 'PyHDESK', 'PyHDEVNOTIFY', 'PyHHNTRACK', 'PyHHN_NOTIFY', 'PyHH_AKLINK', 'PyHH_FTS_QUERY', 'PyHH_POPUP', 'PyHH_WINTYPE', 'PyHINTERNET', 'PyHKEY', 'PyHTHEME', 'PyHWINSTA', 'PyICONINFO', 'PyIID', 'PyINPUT_RECORD', 'PyLOCALGROUP_INFO_0', 'PyLOCALGROUP_INFO_1', 'PyLOCALGROUP_INFO_1002', 'PyLOCALGROUP_MEMBERS_INFO_0', 'PyLOCALGROUP_MEMBERS_INFO_1', 'PyLOCALGROUP_MEMBERS_INFO_2', 'PyLOCALGROUP_MEMBERS_INFO_3', 'PyLOGBRUSH', 'PyLOGFONT', 'PyLSA_HANDLE', 'PyLUID_AND_ATTRIBUTES', 'PyLsaLogon_HANDLE', 'PyMSG', 'PyNETRESOURCE', 'PyNET_VALIDATE_AUTHENTICATION_INPUT_ARG', 'PyNET_VALIDATE_PASSWORD_CHANGE_INPUT_ARG', 'PyNET_VALIDATE_PERSISTED_FIELDS', 'PyNMHDR', 'PyNOTIFYICONDATA', 'PyOVERLAPPED', 'PyOVERLAPPEDReadBuffer', 'PyPERF_COUNTER_DEFINITION', 'PyPERF_OBJECT_TYPE', 'PyPOINT', 'PyPROFILEINFO', 'PyPerfMonManager', 'PyPrinterHANDLE', 'PyRECT', 'PyResourceId', 'PySCROLLINFO', 'PySC_HANDLE', 'PySECURITY_ATTRIBUTES', 'PySECURITY_DESCRIPTOR', 'PySERVER_INFO_100', 'PySERVER_INFO_101', 'PySERVER_INFO_102', 'PySERVER_INFO_402', 'PySERVER_INFO_403', 'PySERVER_INFO_502', 'PySERVER_INFO_503', 'PySHARE_INFO_0', 'PySHARE_INFO_1', 'PySHARE_INFO_2', 'PySHARE_INFO_501', 'PySHARE_INFO_502', 'PySID', 'PySID_AND_ATTRIBUTES', 'PySIZE', 'PySMALL_RECT', 'PySTARTUPINFO', 'PySecBuffer', 'PySecBufferDesc', 'PyTOKEN_GROUPS', 'PyTOKEN_PRIVILEGES', 'PyTRIVERTEX', 'PyTRUSTEE', 'PyTS_HANDLE', 'PyTime', 'PyUSER_INFO_0', 'PyUSER_INFO_1', 'PyUSER_INFO_10', 'PyUSER_INFO_1003', 'PyUSER_INFO_1005', 'PyUSER_INFO_1006', 'PyUSER_INFO_1007', 'PyUSER_INFO_1008', 'PyUSER_INFO_1009', 'PyUSER_INFO_1010', 'PyUSER_INFO_1011', 'PyUSER_INFO_11', 'PyUSER_INFO_2', 'PyUSER_INFO_20', 'PyUSER_INFO_3', 'PyUSER_INFO_4', 'PyUSER_MODALS_INFO_0', 'PyUSER_MODALS_INFO_1', 'PyUSER_MODALS_INFO_2', 'PyUSER_MODALS_INFO_3', 'PyUSE_INFO_0', 'PyUSE_INFO_1', 'PyUSE_INFO_2', 'PyUSE_INFO_3', 'PyUnicode', 'PyUrlCacheHANDLE', 'PyWAVEFORMATEX', 'PyWINHTTP_AUTOPROXY_OPTIONS', 'PyWINHTTP_PROXY_INFO', 'PyWKSTA_INFO_100', 'PyWKSTA_INFO_101', 'PyWKSTA_INFO_102', 'PyWKSTA_INFO_302', 'PyWKSTA_INFO_402', 'PyWKSTA_INFO_502', 'PyWKSTA_TRANSPORT_INFO_0', 'PyWKSTA_USER_INFO_0', 'PyWKSTA_USER_INFO_1', 'PyWNDCLASS', 'PyXFORM', 'Pymmapfile', 'RASDIALEXTENSIONS', 'RASDIALPARAMS', 'SC_ACTION', 'SERVICE_FAILURE_ACTIONS', 'SERVICE_STATUS', 'TRACKMOUSEEVENT', 'ULARGE_INTEGER', 'WIN32_FIND_DATA', 'com_error', 'connection', 'cursor', 'error', 'COMPONENT', 'COMPONENTSOPT', 'COMPPOS', 'COMPSTATEINFO', 'DEFCONTENTMENU', 'ELEMDESC', 'EXP_DARWIN_LINK', 'EXP_SPECIAL_FOLDER', 'EXP_SZ_LINK', 'FUNCDESC', 'IDLDESC', 'MAPIINIT_0', 'NT_CONSOLE_PROPS', 'NT_FE_CONSOLE_PROPS', 'PROPSPEC', 'PyADSVALUE', 'PyADS_ATTR_INFO', 'PyADS_OBJECT_INFO', 'PyADS_SEARCHPREF_INFO', 'PyBIND_OPTS', 'PyCMINVOKECOMMANDINFO', 'PyDSBCAPS', 'PyDSBUFFERDESC', 'PyDSCAPS', 'PyDSCBCAPS', 'PyDSCBUFFERDESC', 'PyDSCCAPS', 'PyDSOP_FILTER_FLAGS', 'PyDSOP_SCOPE_INIT_INFO', 'PyDSOP_SCOPE_INIT_INFOs', 'PyDSOP_UPLEVEL_FILTER_FLAGS', 'PyFORMATETC', 'PyGFileOperationProgressSink', 'PyGSecurityInformation', 'PyIADesktopP2', 'PyIADs', 'PyIADsContainer', 'PyIADsUser', 'PyIActiveDesktop', 'PyIActiveDesktopP', 'PyIActiveScriptDebug', 'PyIActiveScriptError', 'PyIActiveScriptErrorDebug', 'PyIActiveScriptParseProcedure', 'PyIActiveScriptSite', 'PyIActiveScriptSiteDebug', 'PyIAddrBook', 'PyIApplicationDebugger', 'PyIApplicationDestinations', 'PyIApplicationDocumentLists', 'PyIAsyncOperation', 'PyIAttach', 'PyIBindCtx', 'PyIBrowserFrameOptions', 'PyICancelMethodCalls', 'PyICatInformation', 'PyICatRegister', 'PyICategoryProvider', 'PyIClassFactory', 'PyIClientSecurity', 'PyIColumnProvider', 'PyIConnectionPoint', 'PyIConnectionPointContainer', 'PyIContext', 'PyIContextMenu', 'PyICopyHookA', 'PyICopyHookW', 'PyICreateTypeInfo', 'PyICreateTypeLib', 'PyICreateTypeLib2', 'PyICurrentItem', 'PyICustomDestinationList', 'PyIDL', 'PyIDataObject', 'PyIDebugApplication', 'PyIDebugApplicationNode', 'PyIDebugApplicationNodeEvents', 'PyIDebugApplicationThread', 'PyIDebugCodeContext', 'PyIDebugDocument', 'PyIDebugDocumentContext', 'PyIDebugDocumentHelper', 'PyIDebugDocumentHost', 'PyIDebugDocumentInfo', 'PyIDebugDocumentProvider', 'PyIDebugDocumentText', 'PyIDebugDocumentTextAuthor', 'PyIDebugDocumentTextEvents', 'PyIDebugDocumentTextExternalAuthor', 'PyIDebugExpression', 'PyIDebugExpressionCallBack', 'PyIDebugExpressionContext', 'PyIDebugProperty', 'PyIDebugSessionProvider', 'PyIDebugStackFrame', 'PyIDebugStackFrameSniffer', 'PyIDebugStackFrameSnifferEx', 'PyIDebugSyncOperation', 'PyIDefaultExtractIconInit', 'PyIDirectSound', 'PyIDirectSoundBuffer', 'PyIDirectSoundCapture', 'PyIDirectSoundCaptureBuffer', 'PyIDirectSoundNotify', 'PyIDirectoryObject', 'PyIDirectorySearch', 'PyIDispatch', 'PyIDispatchEx', 'PyIDisplayItem', 'PyIDocHostUIHandler', 'PyIDropSource', 'PyIDropTarget', 'PyIDropTargetHelper', 'PyIDsObjectPicker', 'PyIEmptyVolumeCache', 'PyIEmptyVolumeCache2', 'PyIEmptyVolumeCacheCallBack', 'PyIEnumCATEGORYINFO', 'PyIEnumConnectionPoints', 'PyIEnumConnections', 'PyIEnumContextProps', 'PyIEnumDebugApplicationNodes', 'PyIEnumDebugCodeContexts', 'PyIEnumDebugExpressionContexts', 'PyIEnumDebugPropertyInfo', 'PyIEnumDebugStackFrames', 'PyIEnumExplorerCommand', 'PyIEnumFORMATETC', 'PyIEnumGUID', 'PyIEnumIDList', 'PyIEnumMoniker', 'PyIEnumObjects', 'PyIEnumRemoteDebugApplicationThreads', 'PyIEnumRemoteDebugApplications', 'PyIEnumResources', 'PyIEnumSTATPROPSETSTG', 'PyIEnumSTATPROPSTG', 'PyIEnumSTATSTG', 'PyIEnumShellItems', 'PyIEnumString', 'PyIErrorLog', 'PyIExplorerBrowser', 'PyIExplorerBrowserEvents', 'PyIExplorerCommand', 'PyIExplorerCommandProvider', 'PyIExplorerPaneVisibility', 'PyIExternalConnection', 'PyIExtractIcon', 'PyIExtractIconW', 'PyIExtractImage', 'PyIFileOperation', 'PyIIdentityName', 'PyIInitializeWithFile', 'PyIInitializeWithStream', 'PyIInputObject', 'PyIInternetBindInfo', 'PyIInternetPriority', 'PyIInternetProtocol', 'PyIInternetProtocolInfo', 'PyIInternetProtocolRoot', 'PyIInternetProtocolSink', 'PyIInternetSecurityManager', 'PyIKnownFolder', 'PyIKnownFolderManager', 'PyILockBytes', 'PyIMAPIContainer', 'PyIMAPIFolder', 'PyIMAPIProp', 'PyIMAPISession', 'PyIMAPIStatus', 'PyIMAPITable', 'PyIMachineDebugManager', 'PyIMachineDebugManagerEvents', 'PyIMessage', 'PyIMoniker', 'PyIMsgServiceAdmin', 'PyIMsgStore', 'PyINameSpaceTreeControl', 'PyINamedPropertyStore', 'PyIObjectArray', 'PyIObjectCollection', 'PyIObjectWithPropertyKey', 'PyIObjectWithSite', 'PyIOleClientSite', 'PyIOleCommandTarget', 'PyIOleControl', 'PyIOleControlSite', 'PyIOleInPlaceActiveObject', 'PyIOleInPlaceFrame', 'PyIOleInPlaceObject', 'PyIOleInPlaceSite', 'PyIOleInPlaceSiteEx', 'PyIOleInPlaceSiteWindowless', 'PyIOleInPlaceUIWindow', 'PyIOleObject', 'PyIOleWindow', 'PyIPersist', 'PyIPersistFile', 'PyIPersistFolder', 'PyIPersistFolder2', 'PyIPersistPropertyBag', 'PyIPersistSerializedPropStorage', 'PyIPersistStorage', 'PyIPersistStream', 'PyIPersistStreamInit', 'PyIProcessDebugManager', 'PyIProfAdmin', 'PyIPropertyBag', 'PyIPropertyChange', 'PyIPropertyChangeArray', 'PyIPropertyDescription', 'PyIPropertyDescriptionAliasInfo', 'PyIPropertyDescriptionList', 'PyIPropertyDescriptionSearchInfo', 'PyIPropertyEnumType', 'PyIPropertyEnumTypeList', 'PyIPropertySetStorage', 'PyIPropertyStorage', 'PyIPropertyStore', 'PyIPropertyStoreCache', 'PyIPropertyStoreCapabilities', 'PyIPropertySystem', 'PyIProvideClassInfo', 'PyIProvideClassInfo2', 'PyIProvideExpressionContexts', 'PyIProvideTaskPage', 'PyIQueryAssociations', 'PyIRelatedItem', 'PyIRemoteDebugApplication', 'PyIRemoteDebugApplicationEvents', 'PyIRemoteDebugApplicationThread', 'PyIRunningObjectTable', 'PyIScheduledWorkItem', 'PyIServerSecurity', 'PyIServiceProvider', 'PyIShellBrowser', 'PyIShellExtInit', 'PyIShellFolder', 'PyIShellFolder2', 'PyIShellIcon', 'PyIShellIconOverlay', 'PyIShellIconOverlayIdentifier', 'PyIShellIconOverlayManager', 'PyIShellItem', 'PyIShellItem2', 'PyIShellItemArray', 'PyIShellItemResources', 'PyIShellLibrary', 'PyIShellLink', 'PyIShellLinkDataList', 'PyIShellView', 'PyISpecifyPropertyPages', 'PyIStorage', 'PyIStream', 'PyITask', 'PyITaskScheduler', 'PyITaskTrigger', 'PyITaskbarList', 'PyITransferAdviseSink', 'PyITransferDestination', 'PyITransferMediumItem', 'PyITransferSource', 'PyITypeComp', 'PyITypeInfo', 'PyITypeLib', 'PyIUniformResourceLocator', 'PyIUnknown', 'PyIViewObject', 'PyIViewObject2', 'PyMAPINAMEIDArray', 'PyOLEMENUGROUPWIDTHS', 'PyPROPERTYKEY', 'PyPROPVARIANT', 'PySAndRestriction', 'PySBinaryArray', 'PySBitMaskRestriction', 'PySContentRestriction', 'PySExistRestriction', 'PySHELL_ITEM_RESOURCE', 'PySNotRestriction', 'PySOrRestriction', 'PySPropTagArray', 'PySPropValue', 'PySPropValueArray', 'PySPropertyRestriction', 'PySRestriction', 'PySRow', 'PySRowSet', 'PySSortOrderItem', 'PySSortOrderSet', 'PySTGMEDIUM', 'PyTASK_TRIGGER', 'RTF_WCSINFO', 'SHFILEINFO', 'SHFILEOPSTRUCT', 'SI_ACCESS', 'SI_INHERIT_TYPE', 'SI_OBJECT_INFO', 'STATSTG', 'TLIBATTR', 'TYPEATTR', 'TYPEDESC', 'VARDESC', 'CHARFORMAT', 'CREATESTRUCT', 'LV_COLUMN', 'LV_ITEM', 'PARAFORMAT', 'PyAssocCObject', 'PyAssocObject', 'PyCBitmap', 'PyCBrush', 'PyCButton', 'PyCCmdTarget', 'PyCCmdUI', 'PyCColorDialog', 'PyCComboBox', 'PyCCommonDialog', 'PyCControl', 'PyCControlBar', 'PyCCtrlView', 'PyCDC', 'PyCDialog', 'PyCDialogBar', 'PyCDocTemplate', 'PyCDockContext', 'PyCDocument', 'PyCEdit', 'PyCEditView', 'PyCFileDialog', 'PyCFont', 'PyCFontDialog', 'PyCFormView', 'PyCFrameWnd', 'PyCGdiObject', 'PyCImageList', 'PyCListBox', 'PyCListCtrl', 'PyCListView', 'PyCMDIChildWnd', 'PyCMDIFrameWnd', 'PyCMenu', 'PyCOleClientItem', 'PyCOleDialog', 'PyCOleDocument', 'PyCOleInsertDialog', 'PyCPrintDialog', 'PyCPrintInfo', 'PyCProgressCtrl', 'PyCPropertyPage', 'PyCPropertySheet', 'PyCRect', 'PyCRgn', 'PyCRichEditCtrl', 'PyCRichEditDoc', 'PyCRichEditDocTemplate', 'PyCRichEditView', 'PyCScrollView', 'PyCSliderCtrl', 'PyCSpinButtonCtrl', 'PyCSplitterWnd', 'PyCStatusBar', 'PyCStatusBarCtrl', 'PyCTabCtrl', 'PyCToolBar', 'PyCToolBarCtrl', 'PyCToolTipCtrl', 'PyCTreeCtrl', 'PyCTreeView', 'PyCView', 'PyCWinApp', 'PyCWinThread', 'PyCWnd', 'PyDDEConv', 'PyDDEServer', 'PyDDEStringItem', 'PyDDETopic', 'PyDLL', 'SCROLLINFO', 'TV_ITEM', 'EXTENSION_CONTROL_BLOCK', 'HSE_VERSION_INFO', 'HTTP_FILTER_AUTHENT', 'HTTP_FILTER_CONTEXT', 'HTTP_FILTER_LOG', 'HTTP_FILTER_PREPROC_HEADERS', 'HTTP_FILTER_RAW_DATA', 'HTTP_FILTER_URL_MAP', 'HTTP_FILTER_VERSION'] import typing @@ -226,7 +230,7 @@ Args: Returns: None - + """ pass @@ -242,14 +246,14 @@ Args: Returns: None - + """ pass def AddAccessAllowedAce(self,revision:'typing.Any',access:'typing.Any',sid:'PySID',access1:'typing.Any',sid1:'typing.Any') -> 'None': """ - Adds an access-allowed ACE to an DACL object. The access is granted to a + Adds an access-allowed ACE to an DACL object. The access is granted to a specified SID. @@ -264,7 +268,7 @@ Args: Returns: None - + """ pass @@ -283,7 +287,7 @@ Args: Returns: None - + """ pass @@ -304,14 +308,14 @@ Args: Returns: None - + """ pass def AddAccessDeniedAce(self,revision:'typing.Any',access:'typing.Any',sid:'PySID',access1:'typing.Any',sid1:'typing.Any') -> 'None': """ - Adds an access-denied ACE to an ACL object. The access is denied to a specified + Adds an access-denied ACE to an ACL object. The access is denied to a specified SID. @@ -326,7 +330,7 @@ Args: Returns: None - + """ pass @@ -345,7 +349,7 @@ Args: Returns: None - + """ pass @@ -364,7 +368,7 @@ Args: Returns: None - + """ pass @@ -384,7 +388,7 @@ Args: Returns: None - + """ pass @@ -405,7 +409,7 @@ Args: Returns: None - + """ pass @@ -428,7 +432,7 @@ Args: Returns: None - + """ pass @@ -444,7 +448,7 @@ Args: Returns: typing.Any - + """ pass @@ -460,7 +464,7 @@ Args: Returns: typing.Any - + """ pass @@ -476,7 +480,7 @@ Args: Returns: typing.Any - + """ pass @@ -491,7 +495,7 @@ Args: Returns: - typing.Any:Zero-based index of the ACE to retrieve.Return ValueConventional ACE's (types ACCESS_ALLOWED_ACE, ACCESS_DENIED_ACE, SYSTEM_AUDIT_ACE) are returned + typing.Any:Zero-based index of the ACE to retrieve.Return ValueConventional ACE's (types ACCESS_ALLOWED_ACE, ACCESS_DENIED_ACE, SYSTEM_AUDIT_ACE) are returned as a tuple of: Items[0] (int, int) : aceType, AceFlags @@ -499,7 +503,7 @@ Items[0] (int, int) : aceType, AceFlags [1] int : Mask [2] PySID : sid -Object ACE's (types ACCESS_ALLOWED_OBJECT_ACE, ACCESS_DENIED_OBJECT_ACE, SYSTEM_AUDIT_OBJECT_ACE) +Object ACE's (types ACCESS_ALLOWED_OBJECT_ACE, ACCESS_DENIED_OBJECT_ACE, SYSTEM_AUDIT_OBJECT_ACE) are returned as a tuple: [0] (int, int) : aceType, AceFlags @@ -513,7 +517,7 @@ are returned as a tuple: [4] PySID : sid For details see the API documentation. - + """ pass @@ -529,14 +533,14 @@ Args: Returns: None - + """ pass def GetEffectiveRightsFromAcl(self,trustee:'PyTRUSTEE') -> 'typing.Any': """ - Return access rights (ACCESS_MASK) that the ACL grants to + Return access rights (ACCESS_MASK) that the ACL grants to specified trustee @@ -547,14 +551,14 @@ Args: Returns: typing.Any - + """ pass def GetAuditedPermissionsFromAcl(self,trustee:'PyTRUSTEE') -> 'typing.Tuple[typing.Any, typing.Any]': """ - Return types of access for + Return types of access for which ACL will generate an audit event for specified trustee @@ -565,7 +569,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -608,7 +612,7 @@ class PyBITMAP(object): class PyBLENDFUNCTION(object): - """Tuple of four small ints used to fill a BLENDFUNCTION struct + """Tuple of four small ints used to fill a BLENDFUNCTION struct Each int must fit in a byte (0-255).""" @@ -647,7 +651,7 @@ Args: Returns: None - + """ pass @@ -665,7 +669,7 @@ Args: Returns: None - + """ pass @@ -681,7 +685,7 @@ Args: Returns: typing.List[typing.Any] - + """ pass @@ -697,7 +701,7 @@ Args: Returns: typing.List[typing.Any] - + """ pass @@ -717,14 +721,14 @@ Args: Returns: None - + """ pass def CertAddEncodedCertificateToStore(self,CertEncodingType:'typing.Any',CertEncoded:'typing.Any',AddDisposition:'typing.Any') -> 'PyCERT_CONTEXT': """ - Imports an encoded certificate into the + Imports an encoded certificate into the store @@ -737,7 +741,7 @@ Args: Returns: PyCERT_CONTEXT - + """ pass @@ -754,7 +758,7 @@ Args: Returns: PyCERT_CONTEXT - + """ pass @@ -771,7 +775,7 @@ Args: Returns: PyCERT_CONTEXT - + """ pass @@ -788,7 +792,7 @@ Args: Returns: PyCTL_CONTEXT - + """ pass @@ -805,7 +809,7 @@ Args: Returns: PyCTL_CONTEXT - + """ pass @@ -823,7 +827,7 @@ Args: Returns: None - + """ pass @@ -839,7 +843,7 @@ Args: Returns: None - + """ pass @@ -856,7 +860,7 @@ Args: Returns: typing.Any - + """ pass @@ -1052,7 +1056,7 @@ Args: Returns: None - + """ pass @@ -1068,14 +1072,14 @@ Args: Returns: typing.List[typing.Any] - + """ pass def CryptAcquireCertificatePrivateKey(self,Flags:'typing.Any'=0) -> 'typing.Tuple[typing.Any, PyCRYPTPROV]': """ - Retrieves the private key associated + Retrieves the private key associated with the certificate @@ -1091,14 +1095,14 @@ Comments Only the owner of the certificate can use this method Return ValueReturns the KeySpec (AT_KEYEXCHANGE or AT_SIGNATURE) and a CSP handle to the key - + """ pass def CertGetIntendedKeyUsage(self,) -> 'typing.Any': """ - Returns the intended key usage from the certificate extensions + Returns the intended key usage from the certificate extensions (szOID_KEY_USAGE or szOID_KEY_ATTRIBUTES) @@ -1110,19 +1114,19 @@ Returns: typing.Any:PyCERT_CONTEXT.CertGetIntendedKeyUsage -int = CertGetIntendedKeyUsage()Returns the intended key usage from the certificate extensions +int = CertGetIntendedKeyUsage()Returns the intended key usage from the certificate extensions (szOID_KEY_USAGE or szOID_KEY_ATTRIBUTES) Return ValueReturns a combination of CERT_*_KEY_USAGE values - + """ pass def CertGetEnhancedKeyUsage(self,Flags:'typing.Any'=0) -> 'typing.Any': """ - Finds the enhanced key usage property and/or extension for the + Finds the enhanced key usage property and/or extension for the certificate @@ -1132,12 +1136,12 @@ Args: Returns: - typing.Any:CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG, + typing.Any:CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG, or 0 Return ValueReturns a sequence of usage OIDs - + """ pass @@ -1153,7 +1157,7 @@ Args: Returns: str - + """ pass @@ -1169,11 +1173,11 @@ Args: Returns: - typing.Any:Combination of CERT_STORE_REVOCATION_FLAG,CERT_STORE_SIGNATURE_FLAG and + typing.Any:Combination of CERT_STORE_REVOCATION_FLAG,CERT_STORE_SIGNATURE_FLAG and CERT_STORE_TIME_VALIDITY_FLAG indicating which checks should be performedReturn ValueReturns flags indicating which validity checks failed, or 0 if all were successful. - + """ pass @@ -1189,14 +1193,14 @@ Args: Returns: None - + """ pass def CertGetCertificateContextProperty(self,PropId:'typing.Any') -> 'typing.Any': """ - Retrieves the specified property from the + Retrieves the specified property from the certificate @@ -1231,20 +1235,20 @@ CERT_SIGNATURE_HASH_PROP_IDString containing a hash CERT_KEY_IDENTIFIER_PROP_IDString containing a hash CERT_SUBJECT_NAME_MD5_HASH_PROP_IDString containing a hash CERT_KEY_PROV_HANDLE_PROP_IDPyCRYPTPROV -CERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_IDString +CERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_IDString containing a hash -CERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_IDString +CERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_IDString containing a hash -CERT_CTL_USAGE_PROP_IDEncoded CTL_USAGE, decode as X509_ENHANCED_KEY_USAGE (CTL_USAGE and +CERT_CTL_USAGE_PROP_IDEncoded CTL_USAGE, decode as X509_ENHANCED_KEY_USAGE (CTL_USAGE and CERT_ENHKEY_USAGE are identical) CERT_ENHKEY_USAGE_PROP_IDEncoded CTL_USAGE. Can be decoded using cryptoapi::CryptDecodeObjectEx - + with X509_ENHANCED_KEY_USAGE CERT_KEY_PROV_INFO_PROP_IDCRYPT_KEY_PROV_INFO dict @@ -1256,7 +1260,7 @@ CERT_NEXT_UPDATE_LOCATION_PROP_IDEncoded CERT_ALT_NAME_INFO, decode using crypto with szOID_NEXT_UPDATE_LOCATION Return ValueType of object returned is dependent on the property id requested. - + """ pass @@ -1274,7 +1278,7 @@ Args: Returns: None - + """ pass @@ -1344,11 +1348,11 @@ class PyCERT_NAME_VALUE(object): class PyCERT_OTHER_NAME(object): - """Dict containing {ObjId, Value}. + """Dict containing {ObjId, Value}. -ObjId is one of the string object id's identifying the type of name. +ObjId is one of the string object id's identifying the type of name. -Value is a binary string containing an encoded CERT_NAME_VALUE that can be decoded +Value is a binary string containing an encoded CERT_NAME_VALUE that can be decoded using X509_UNICODE_NAME_VALUE to return the actual unicode string""" @@ -1682,7 +1686,7 @@ Args: Returns: None - + """ pass @@ -1698,7 +1702,7 @@ Args: Returns: PyCRYPTHASH - + """ pass @@ -1715,7 +1719,7 @@ Args: Returns: None - + """ pass @@ -1732,7 +1736,7 @@ Args: Returns: None - + """ pass @@ -1749,7 +1753,7 @@ Args: Returns: str - + """ pass @@ -1767,7 +1771,7 @@ Args: Returns: None - + """ pass @@ -1789,7 +1793,7 @@ Comments After this method has been called, no more data can be hashed Return ValueType of returned object is dependent on the Param passed in - + """ pass @@ -1824,7 +1828,7 @@ Args: Returns: None - + """ pass @@ -1844,7 +1848,7 @@ Returns: typing.Any:Combination of CRYPT_DESTROYKEY,CRYPT_SSL2_FALLBACK,CRYPT_OAEP or 0 Return ValueReturns a binary blob that can be imported via PyCRYPTPROV::CryptImportKey - + """ pass @@ -1863,7 +1867,7 @@ Returns: typing.Any:Reserved, use only 0 Return ValueType of returned object is dependent on the requested attribute - + """ pass @@ -1880,7 +1884,7 @@ Args: Returns: PyCRYPTKEY - + """ pass @@ -1899,7 +1903,7 @@ Args: Returns: typing.Any - + """ pass @@ -1918,7 +1922,7 @@ Args: Returns: typing.Any - + """ pass @@ -1947,7 +1951,7 @@ Args: Returns: None - + """ pass @@ -1977,7 +1981,7 @@ Args: Returns: None - + """ pass @@ -1995,7 +1999,7 @@ Args: Returns: PyCRYPTKEY - + """ pass @@ -2011,12 +2015,12 @@ Args: Returns: - None:If param if PP_KEYSET_SEC_DESCR, can be a combination of + None:If param if PP_KEYSET_SEC_DESCR, can be a combination of OWNER_SECURITY_INFORMATION,GROUP_SECURITY_INFORMATION,DACL_SECURITY_INFORMATION,SACL_SECURITY_INFORMATION Return ValueType of returned object is dependent on the attribute requested - + """ pass @@ -2032,7 +2036,7 @@ Args: Returns: PyCRYPTKEY - + """ pass @@ -2049,7 +2053,7 @@ Args: Returns: str - + """ pass @@ -2067,7 +2071,7 @@ Args: Returns: PyCRYPTHASH - + """ pass @@ -2085,14 +2089,14 @@ Args: Returns: PyCRYPTKEY - + """ pass def CryptExportPublicKeyInfo(self,KeySpec:'typing.Any',CertEncodingType:'typing.Any') -> 'PyCERT_PUBLIC_KEY_INFO': """ - Exports a public key to send to other users + Exports a public key to send to other users Returned dict can be serialized for sending to another python application using pickle.dump @@ -2104,7 +2108,7 @@ Args: Returns: PyCERT_PUBLIC_KEY_INFO - + """ pass @@ -2121,13 +2125,13 @@ Args: Returns: PyCRYPTKEY - + """ pass class PyCRYPT_ALGORITHM_IDENTIFIER(object): - """Dictionary containing information that identifies an encryption + """Dictionary containing information that identifies an encryption algorithm and any extra parameters it requires""" @@ -2375,7 +2379,7 @@ Args: Returns: None - + """ pass @@ -2391,7 +2395,7 @@ Args: Returns: typing.Tuple[typing.Any, ...] - + """ pass @@ -2411,7 +2415,7 @@ Returns: ((str,str),...) = CertEnumSubjectInSortedCTL()Retrieves trusted subjects contained in CRL Return ValueReturns a sequence of tuples containing two strings (SubjectIdentifier, EncodedAttributes) - + """ pass @@ -2427,7 +2431,7 @@ Args: Returns: None - + """ pass @@ -2443,7 +2447,7 @@ Args: Returns: str - + """ pass @@ -2464,7 +2468,7 @@ class PyConsoleScreenBuffer(object): def SetConsoleActiveScreenBuffer(self,) -> 'None': """ - Sets this handle as the currently displayed screen + Sets this handle as the currently displayed screen buffer @@ -2475,14 +2479,14 @@ Args: Returns: None - + """ pass def GetConsoleCursorInfo(self,) -> 'typing.Tuple[typing.Any, typing.Any]': """ - Retrieves size and visibility of console's + Retrieves size and visibility of console's cursor @@ -2494,14 +2498,14 @@ Returns: typing.Tuple[typing.Any, typing.Any]:PyConsoleScreenBuffer.GetConsoleCursorInfo -(Size, bVisible) = GetConsoleCursorInfo()Retrieves size and visibility of console's +(Size, bVisible) = GetConsoleCursorInfo()Retrieves size and visibility of console's cursor -Return ValueReturns the size of the console's cursor expressed as a percentage of character size, and a boolen indicating +Return ValueReturns the size of the console's cursor expressed as a percentage of character size, and a boolen indicating if cursor is visible - + """ pass @@ -2518,7 +2522,7 @@ Args: Returns: None - + """ pass @@ -2538,7 +2542,7 @@ Returns: int = GetConsoleMode()Returns the input or output mode of the console buffer Return ValueReturns a combination of ENABLE_*_INPUT or ENABLE_*_OUTPUT constants - + """ pass @@ -2554,7 +2558,7 @@ Args: Returns: None - + """ pass @@ -2570,7 +2574,7 @@ Args: Returns: typing.Any - + """ pass @@ -2587,7 +2591,7 @@ Returns: typing.Any:String or Unicode to be written to consoleReturn ValueReturns the number of characters written - + """ pass @@ -2603,7 +2607,7 @@ Args: Returns: None - + """ pass @@ -2619,7 +2623,7 @@ Args: Returns: None - + """ pass @@ -2635,7 +2639,7 @@ Args: Returns: None - + """ pass @@ -2651,7 +2655,7 @@ Args: Returns: None - + """ pass @@ -2668,7 +2672,7 @@ Args: Returns: None - + """ pass @@ -2684,14 +2688,14 @@ Args: Returns: typing.Any - + """ pass def GetLargestConsoleWindowSize(self,) -> 'PyCOORD': """ - Returns the largest possible size for the + Returns the largest possible size for the console's window @@ -2702,14 +2706,14 @@ Args: Returns: PyCOORD - + """ pass def FillConsoleOutputAttribute(self,Attribute:'typing.Any',Length:'typing.Any',WriteCoord:'PyCOORD') -> 'typing.Any': """ - Set text attributes for a consecutive series of + Set text attributes for a consecutive series of characters @@ -2723,14 +2727,14 @@ Returns: typing.Any:The screen position to begin atReturn ValueReturns the number of character cells whose attributes were set - + """ pass def FillConsoleOutputCharacter(self,Character:'typing.Any',Length:'typing.Any',WriteCoord:'PyCOORD') -> 'typing.Any': """ - Sets consecutive character positions to a specified + Sets consecutive character positions to a specified character @@ -2744,14 +2748,14 @@ Returns: typing.Any:The screen position to begin atReturn ValueReturns the number of characters actually written - + """ pass def ReadConsoleOutputCharacter(self,Length:'typing.Any',ReadCoord:'PyCOORD') -> 'str': """ - Reads consecutive characters from a starting + Reads consecutive characters from a starting position @@ -2763,14 +2767,14 @@ Args: Returns: str - + """ pass def ReadConsoleOutputAttribute(self,Length:'typing.Any',ReadCoord:'PyCOORD') -> 'typing.Tuple[typing.Any, ...]': """ - Retrieves attributes from consecutive character + Retrieves attributes from consecutive character cells @@ -2783,7 +2787,7 @@ Returns: typing.Tuple[typing.Any, ...]:The screen position from which to start readingReturn ValueReturns a sequence of ints containing the attributes of a range of characters - + """ pass @@ -2801,7 +2805,7 @@ Returns: typing.Any:The screen position at which to start writingReturn ValueReturns the number of characters actually written - + """ pass @@ -2819,7 +2823,7 @@ Returns: typing.Any:The screen position at which to start writingReturn ValueReturns the number of attributes set - + """ pass @@ -2839,7 +2843,7 @@ Args: Returns: None - + """ pass @@ -2857,14 +2861,14 @@ Returns: typing.Tuple[typing.Any, PyCOORD]:If True, retrieves font size for maximum window size Comments -Only exists on XP or later. +Only exists on XP or later. -MSDN docs claim the returned COORD is the font size, but it's actually the window size. +MSDN docs claim the returned COORD is the font size, but it's actually the window size. Use PyConsoleScreenBuffer::GetConsoleFontSize for the font size. Return ValueReturns the index of current font and window size - + """ pass @@ -2880,7 +2884,7 @@ Args: Returns: PyCOORD - + """ pass @@ -2896,7 +2900,7 @@ Args: Returns: None - + """ pass @@ -2912,7 +2916,7 @@ Args: Returns: None - + """ pass @@ -2929,7 +2933,7 @@ Args: Returns: None - + """ pass @@ -2946,14 +2950,14 @@ Returns: typing.Any:A sequence of PyINPUT_RECORD objectsReturn ValueReturns the number of records written - + """ pass def ReadConsoleInput(self,Length:'typing.Any') -> 'typing.Tuple[PyINPUT_RECORD, ...]': """ - Reads input records and removes them from + Reads input records and removes them from the input queue @@ -2965,19 +2969,19 @@ Returns: typing.Tuple[PyINPUT_RECORD, ...]:The number of input records to readComments -This functions blocks until at least one record is read. +This functions blocks until at least one record is read. The number of records returned may be less than the nbr requested Return ValueReturns a sequence of PyINPUT_RECORD objects - + """ pass def PeekConsoleInput(self,Length:'typing.Any') -> 'typing.Tuple[PyINPUT_RECORD, ...]': """ - Returns pending input records without + Returns pending input records without removing them from the input queue @@ -2989,19 +2993,19 @@ Returns: typing.Tuple[PyINPUT_RECORD, ...]:The number of input records to readComments -This function does not block as ReadConsoleInput does. +This function does not block as ReadConsoleInput does. The number of records returned may be less than the nbr requested Return ValueReturns a sequence of PyINPUT_RECORD objects - + """ pass def GetNumberOfConsoleInputEvents(self,) -> 'typing.Any': """ - Returns the number of unread records in the input + Returns the number of unread records in the input queue @@ -3012,7 +3016,7 @@ Args: Returns: typing.Any - + """ pass @@ -3035,7 +3039,7 @@ Args: Returns: typing.Any - + """ pass @@ -3051,7 +3055,7 @@ Args: Returns: None - + """ pass @@ -3080,18 +3084,18 @@ Return type SECPKG_CRED_ATTR_NAMESPyUnicode - returns username that credentials represent -SECPKG_ATTR_SUPPORTED_ALGSNot supported yet +SECPKG_ATTR_SUPPORTED_ALGSNot supported yet SecPkgCred_SupportedAlgs: -SECPKG_ATTR_CIPHER_STRENGTHSNot supported yet +SECPKG_ATTR_CIPHER_STRENGTHSNot supported yet SecPkgCred_CipherStrengths: -SECPKG_ATTR_SUPPORTED_PROTOCOLSNot supported yet +SECPKG_ATTR_SUPPORTED_PROTOCOLSNot supported yet SecPkgCred_SupportedProtocols: Return ValueType of returned values is dependent on Attribute - + """ pass @@ -3114,7 +3118,7 @@ Args: Returns: typing.Any - + """ pass @@ -3130,7 +3134,7 @@ Args: Returns: None - + """ pass @@ -3146,7 +3150,7 @@ Args: Returns: None - + """ pass @@ -3162,7 +3166,7 @@ Args: Returns: None - + """ pass @@ -3178,14 +3182,14 @@ Args: Returns: typing.Any - + """ pass def MakeSignature(self,fqop:'typing.Any',Message:'PySecBufferDesc',MessageSeqNo:'typing.Any') -> 'None': """ - Creates a crytographic hash of a message using session key of the security + Creates a crytographic hash of a message using session key of the security context @@ -3197,16 +3201,16 @@ Args: Returns: - None:A sequential number used by some packages to verify that no extraneous messages have + None:A sequential number used by some packages to verify that no extraneous messages have been receivedComments -The buffer configuration is dependent on the security package. Usually there is one input buffer of +The buffer configuration is dependent on the security package. Usually there is one input buffer of type SECBUFFER_DATA and an output buffer of type SECBUFFER_TOKEN Return ValueReturns None on success, and output buffer in Message will contain the signature - + """ pass @@ -3222,18 +3226,18 @@ Args: Returns: - None:A sequential number used by some packages to verify that no extraneous messages have + None:A sequential number used by some packages to verify that no extraneous messages have been receivedComments -The buffer configuration is dependent on the security package. Usually there is a data buffer of type +The buffer configuration is dependent on the security package. Usually there is a data buffer of type -SECBUFFER_DATA +SECBUFFER_DATA and a signature buffer of type SECBUFFER_TOKEN Return ValueReturns quality of protection flags used to create signature - + """ pass @@ -3250,18 +3254,18 @@ Args: Returns: - None:A sequential number used by some packages to verify that no extraneous messages have + None:A sequential number used by some packages to verify that no extraneous messages have been receivedComments -The buffer configuration is dependent on the security package. Usually there is one input buffer +The buffer configuration is dependent on the security package. Usually there is one input buffer -of type SECBUFFER_DATA to be encrypted in-place and another empty buffer of type SECBUFFER_PADDING or +of type SECBUFFER_DATA to be encrypted in-place and another empty buffer of type SECBUFFER_PADDING or SECBUFFER_TOKEN to receive signature or padding data Return ValueReturns None on success, and buffer(s) will contain encrypted data - + """ pass @@ -3277,20 +3281,20 @@ Args: Returns: - None:A sequential number used by some packages to verify that no extraneous messages have + None:A sequential number used by some packages to verify that no extraneous messages have been receivedComments -The buffer configuration is dependent on the security package. Usually there is one buffer +The buffer configuration is dependent on the security package. Usually there is one buffer -of type SECBUFFER_DATA which is modified in place and a second buffer of type SECBUFFER_TOKEN or +of type SECBUFFER_DATA which is modified in place and a second buffer of type SECBUFFER_TOKEN or -SECBUFFER_PADDING containing signature, padding, or other extra data from encryption process that doesn't fit +SECBUFFER_PADDING containing signature, padding, or other extra data from encryption process that doesn't fit in first buffer Return ValueReturns flags specfic to security package indicating quality of protection - + """ pass @@ -3306,7 +3310,7 @@ Args: Returns: None - + """ pass @@ -3322,7 +3326,7 @@ Args: Returns: None - + """ pass @@ -3754,7 +3758,7 @@ Args: Returns: None - + """ pass @@ -4060,7 +4064,7 @@ Args: Returns: None - + """ pass @@ -4111,7 +4115,7 @@ Args: Returns: typing.Any - + """ pass @@ -4131,9 +4135,9 @@ class PyEVTLOG_HANDLE(object): class PyEVT_HANDLE(object): - """Handle to an event log, session, query, or any other object used with + """Handle to an event log, session, query, or any other object used with -the Evt* event log functions on Vista and later. +the Evt* event log functions on Vista and later. When the object is destroyed, EvtClose is called.""" @@ -4398,7 +4402,7 @@ Args: Returns: None - + """ pass @@ -4414,7 +4418,7 @@ Args: Returns: None - + """ pass @@ -4434,18 +4438,18 @@ Returns: int = Detach()Detaches the Win32 handle from the handle object. Comments -After calling this function, the handle is effectively invalidated, +After calling this function, the handle is effectively invalidated, -but the handle is not closed. You would call this function when you +but the handle is not closed. You would call this function when you -need the underlying win32 handle to exist beyond the lifetime of the +need the underlying win32 handle to exist beyond the lifetime of the handle object. -Return ValueThe result is the value of the handle before it is detached. If the +Return ValueThe result is the value of the handle before it is detached. If the handle is already detached, this will return zero. - + """ pass @@ -4468,7 +4472,7 @@ Args: Returns: None - + """ pass @@ -4484,7 +4488,7 @@ Args: Returns: typing.Tuple[int, ...] - + """ pass @@ -4500,7 +4504,7 @@ Args: Returns: None - + """ pass @@ -4516,7 +4520,7 @@ Args: Returns: None - + """ pass @@ -4529,7 +4533,7 @@ class PyHDEVNOTIFY(object): class PyHHNTRACK(object): - """A Python object, representing an HHNTRACK + """A Python object, representing an HHNTRACK structure""" @@ -4562,7 +4566,7 @@ structure""" class PyHHN_NOTIFY(object): - """A Python object, representing an HHN_NOTIFY + """A Python object, representing an HHN_NOTIFY structure""" @@ -4626,7 +4630,7 @@ class PyHH_AKLINK(object): class PyHH_FTS_QUERY(object): - """A Python object, representing an HH_FTS_QUERY + """A Python object, representing an HH_FTS_QUERY structure""" @@ -4939,7 +4943,7 @@ Args: Returns: typing.Tuple[typing.Any, ...] - + """ pass @@ -4955,7 +4959,7 @@ Args: Returns: None - + """ pass @@ -4971,7 +4975,7 @@ Args: Returns: None - + """ pass @@ -4991,7 +4995,7 @@ class PyIID(object): class PyINPUT_RECORD(object): - """Interface to the INPUT_RECORD struct used with console IO functions. Create using + """Interface to the INPUT_RECORD struct used with console IO functions. Create using PyINPUT_RECORDType(EventType)""" @@ -5123,7 +5127,7 @@ class PyLOCALGROUP_INFO_1002(object): class PyLOCALGROUP_MEMBERS_INFO_0(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_0 + """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_0 structure.""" @@ -5138,7 +5142,7 @@ structure.""" class PyLOCALGROUP_MEMBERS_INFO_1(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_1 + """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_1 structure.""" @@ -5165,7 +5169,7 @@ structure.""" class PyLOCALGROUP_MEMBERS_INFO_2(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_2 + """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_2 structure.""" @@ -5192,7 +5196,7 @@ structure.""" class PyLOCALGROUP_MEMBERS_INFO_3(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_3 + """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_3 structure.""" @@ -5427,7 +5431,7 @@ class PyNET_VALIDATE_PERSISTED_FIELDS(object): class PyNMHDR(object): - """A Python object, representing an NMHDR + """A Python object, representing an NMHDR structure""" @@ -5517,7 +5521,7 @@ class PyOVERLAPPEDReadBuffer(object): class PyPERF_COUNTER_DEFINITION(object): - """An object encapsulating a Windows NT Performance Monitor counter definition + """An object encapsulating a Windows NT Performance Monitor counter definition (PERF_COUNTER_DEFINITION).""" @@ -5566,7 +5570,7 @@ Args: Returns: None - + """ pass @@ -5582,7 +5586,7 @@ Args: Returns: None - + """ pass @@ -5598,7 +5602,7 @@ Args: Returns: None - + """ pass @@ -5614,7 +5618,7 @@ Args: Returns: None - + """ pass @@ -5655,7 +5659,7 @@ Args: Returns: None - + """ pass @@ -5734,7 +5738,7 @@ Args: Returns: None - + """ pass @@ -5811,7 +5815,7 @@ Args: Returns: None - + """ pass @@ -5827,14 +5831,14 @@ Args: Returns: PySID - + """ pass def GetSecurityDescriptorDacl(self,) -> 'PyACL': """ - Return the discretionary ACL of the security + Return the discretionary ACL of the security descriptor. @@ -5845,7 +5849,7 @@ Args: Returns: PyACL - + """ pass @@ -5861,14 +5865,14 @@ Args: Returns: PyACL - + """ pass def GetSecurityDescriptorControl(self,) -> 'typing.Tuple[typing.Any, typing.Any]': """ - Returns tuple of Control bit flags and + Returns tuple of Control bit flags and revision of SD. @@ -5879,7 +5883,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -5896,7 +5900,7 @@ Args: Returns: None - + """ pass @@ -5913,14 +5917,14 @@ Args: Returns: typing.Any - + """ pass def SetSecurityDescriptorSacl(self,bSaclPresent:'typing.Any',SACL:'PyACL',bSaclDefaulted:'typing.Any') -> 'None': """ - Replaces system access control list (SACL) in the security + Replaces system access control list (SACL) in the security descriptor. @@ -5933,7 +5937,7 @@ Args: Returns: None - + """ pass @@ -5949,7 +5953,7 @@ Args: Returns: None - + """ pass @@ -5965,7 +5969,7 @@ Args: Returns: None - + """ pass @@ -5981,14 +5985,14 @@ Args: Returns: None - + """ pass def SetSecurityDescriptorControl(self,ControlBitsOfInterest:'typing.Any',ControlBitsToSet:'typing.Any') -> 'None': """ - Sets the control bit flags related to inheritance for a + Sets the control bit flags related to inheritance for a security descriptor @@ -6000,7 +6004,7 @@ Args: Returns: None - + """ pass @@ -7062,7 +7066,7 @@ Args: Returns: None - + """ pass @@ -7078,7 +7082,7 @@ Args: Returns: None - + """ pass @@ -7095,7 +7099,7 @@ Args: Returns: None - + """ pass @@ -7111,7 +7115,7 @@ Args: Returns: typing.Any - + """ pass @@ -7127,7 +7131,7 @@ Args: Returns: typing.Any - + """ pass @@ -7143,14 +7147,14 @@ Args: Returns: typing.Any - + """ pass def GetSidIdentifierAuthority(self,) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any, typing.Any]': """ - Returns a tuple of 6 SID_IDENTIFIER_AUTHORITY + Returns a tuple of 6 SID_IDENTIFIER_AUTHORITY constants @@ -7161,7 +7165,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass @@ -7181,7 +7185,7 @@ class PySIZE(object): class PySMALL_RECT(object): - """Wrapper for a SMALL_RECT struct + """Wrapper for a SMALL_RECT struct Create using PySMALL_RECTType(Left, Top, Right, Bottom). All params optional, defaulting to 0""" @@ -7305,7 +7309,7 @@ class PySTARTUPINFO(object): class PySecBuffer(object): - """Python object wrapping a SecBuffer structure + """Python object wrapping a SecBuffer structure Created using win32security.PySecBufferType(type,size) where type is a SECBUFFER_* constant""" @@ -7348,7 +7352,7 @@ Args: Returns: None - + """ pass @@ -7371,7 +7375,7 @@ Args: Returns: None - + """ pass @@ -7543,7 +7547,7 @@ Args: Returns: str - + """ pass @@ -9536,13 +9540,13 @@ Args: Returns: None - + """ pass class PyXFORM(object): - """Dict representing an XFORM struct used as a world transformation matrix + """Dict representing an XFORM struct used as a world transformation matrix All members are optional, defaulting to 0.0.""" @@ -9604,7 +9608,7 @@ Args: Returns: None - + """ pass @@ -9622,7 +9626,7 @@ Returns: typing.Any:Pos at which to start search, current pos assumed if not specifiedReturn ValueReturns pos of string, or -1 if not found - + """ pass @@ -9639,7 +9643,7 @@ Args: Returns: None - + """ pass @@ -9657,7 +9661,7 @@ Args: Returns: None - + """ pass @@ -9673,7 +9677,7 @@ Args: Returns: typing.Any - + """ pass @@ -9689,7 +9693,7 @@ Args: Returns: typing.Any - + """ pass @@ -9705,7 +9709,7 @@ Args: Returns: typing.Any - + """ pass @@ -9723,7 +9727,7 @@ Args: Returns: None - + """ pass @@ -9740,7 +9744,7 @@ Args: Returns: None - + """ pass @@ -9756,7 +9760,7 @@ Args: Returns: typing.Any - + """ pass @@ -9772,7 +9776,7 @@ Args: Returns: typing.Any - + """ pass @@ -9788,7 +9792,7 @@ Args: Returns: None - + """ pass @@ -9804,13 +9808,13 @@ Args: Returns: None - + """ pass class RASDIALEXTENSIONS(object): - """An object that describes a Win32 RASDIALEXTENSIONS structure + """An object that describes a Win32 RASDIALEXTENSIONS structure TRUE*/)""" @@ -9958,7 +9962,7 @@ Args: Returns: None - + """ pass @@ -9974,7 +9978,7 @@ Args: Returns: None - + """ pass @@ -9990,7 +9994,7 @@ Args: Returns: None - + """ pass @@ -10006,7 +10010,7 @@ Args: Returns: None - + """ pass @@ -10022,7 +10026,7 @@ Args: Returns: None - + """ pass @@ -10045,7 +10049,7 @@ Args: Returns: None - + """ pass @@ -10062,7 +10066,7 @@ Args: Returns: typing.Any - + """ pass @@ -10078,7 +10082,7 @@ Args: Returns: typing.Any - + """ pass @@ -10094,7 +10098,7 @@ Args: Returns: typing.List[typing.Any] - + """ pass @@ -10110,7 +10114,7 @@ Args: Returns: typing.List[typing.Any] - + """ pass @@ -10126,7 +10130,7 @@ Args: Returns: None - + """ pass @@ -10142,7 +10146,7 @@ Args: Returns: None - + """ pass @@ -10816,7 +10820,7 @@ class PyADS_SEARCHPREF_INFO(object): class PyBIND_OPTS(object): - """Dictionary representation of a BIND_OPTS struct + """Dictionary representation of a BIND_OPTS struct May eventually be extended to include BIND_OPTS2 members""" @@ -11226,7 +11230,7 @@ Args: Returns: None - + """ pass @@ -11242,7 +11246,7 @@ Args: Returns: None - + """ pass @@ -11260,7 +11264,7 @@ Args: Returns: None - + """ pass @@ -11280,7 +11284,7 @@ Args: Returns: None - + """ pass @@ -11299,7 +11303,7 @@ Args: Returns: None - + """ pass @@ -11320,7 +11324,7 @@ Args: Returns: None - + """ pass @@ -11339,7 +11343,7 @@ Args: Returns: None - + """ pass @@ -11360,7 +11364,7 @@ Args: Returns: None - + """ pass @@ -11377,7 +11381,7 @@ Args: Returns: None - + """ pass @@ -11396,7 +11400,7 @@ Args: Returns: None - + """ pass @@ -11414,7 +11418,7 @@ Args: Returns: None - + """ pass @@ -11436,7 +11440,7 @@ Args: Returns: None - + """ pass @@ -11453,7 +11457,7 @@ Args: Returns: None - + """ pass @@ -11469,7 +11473,7 @@ Args: Returns: None - + """ pass @@ -11485,7 +11489,7 @@ Args: Returns: None - + """ pass @@ -11501,7 +11505,7 @@ Args: Returns: None - + """ pass @@ -11515,7 +11519,7 @@ class PyGSecurityInformation(object): def GetObjectInformation(self,) -> 'SI_OBJECT_INFO': """ - Returns information identifying the object + Returns information identifying the object whose security is to be editted, and which pages are to appear in the property sheet @@ -11526,26 +11530,26 @@ Args: Returns: SI_OBJECT_INFO:PyGSecurityInformation.GetObjectInformation -SI_OBJECT_INFO = GetObjectInformation()Returns information identifying the object +SI_OBJECT_INFO = GetObjectInformation()Returns information identifying the object whose security is to be editted, and which pages are to appear in the property sheet Comments -Due to peculiarities of the underlying system calls, this method will only be called once, +Due to peculiarities of the underlying system calls, this method will only be called once, -and subsequent calls will return the information obtained on the first call. As a consequence, a new +and subsequent calls will return the information obtained on the first call. As a consequence, a new instance of the interface will need to be created for each object whose security is to be displayed. Return ValueYour implementation of this method should return a SI_OBJECT_INFO tuple - + """ pass def GetSecurity(self,RequestedInformation:'typing.Any',Default:'typing.Any') -> 'PySECURITY_DESCRIPTOR': """ - Retrieves the object's current security + Retrieves the object's current security settings @@ -11557,7 +11561,7 @@ Args: Returns: PySECURITY_DESCRIPTOR - + """ pass @@ -11575,7 +11579,7 @@ Returns: None:The security information to be applied to the objectReturn ValueAny returned value is ignored - + """ pass @@ -11591,13 +11595,13 @@ Args: Returns: - typing.Tuple[SI_ACCESS, typing.Any]:Indicates which page is requesting the access rights (SI_ADVANCED, SI_EDIT_AUDITS, + typing.Tuple[SI_ACCESS, typing.Any]:Indicates which page is requesting the access rights (SI_ADVANCED, SI_EDIT_AUDITS, -SI_EDIT_PROPERTIES)Return ValueThis method should return a 2-tuple containing a sequence of SI_ACCESS tuples, +SI_EDIT_PROPERTIES)Return ValueThis method should return a 2-tuple containing a sequence of SI_ACCESS tuples, and a zero-based index indicating which of them is the default - + """ pass @@ -11619,14 +11623,14 @@ Returns: See win32security::MapGenericMask Return ValueThis method should return the input bitmask will all generic rights mapped to specific rights - + """ pass def GetInheritTypes(self,) -> 'typing.Tuple[SI_INHERIT_TYPE, ...]': """ - Requests types of inheritance that your + Requests types of inheritance that your implementation supports @@ -11638,12 +11642,12 @@ Returns: typing.Tuple[SI_INHERIT_TYPE, ...]:PyGSecurityInformation.GetInheritTypes -(SI_INHERIT_TYPE,...) = GetInheritTypes()Requests types of inheritance that your +(SI_INHERIT_TYPE,...) = GetInheritTypes()Requests types of inheritance that your implementation supports Return ValueReturns a sequence of SI_INHERIT_TYPE tuples - + """ pass @@ -11662,7 +11666,7 @@ Returns: None:SI_PAGE_TYPE value indicating which page is making the call (ntsecuritycon.SI_PAGE_*)Return ValueAny returned value will be ignored - + """ pass @@ -11685,17 +11689,17 @@ Args: Returns: None - + """ pass class PyIADs(object): - """An object representing the IADs interface. + """An object representing the IADs interface. -In most cases you can achieve the same result via IDispatch - however, this +In most cases you can achieve the same result via IDispatch - however, this -interface allows you get get and set properties without the IDispatch +interface allows you get get and set properties without the IDispatch overhead.""" @@ -11756,7 +11760,7 @@ Args: Returns: None - + """ pass @@ -11772,7 +11776,7 @@ Args: Returns: None - + """ pass @@ -11787,11 +11791,11 @@ Args: Returns: - typing.Any:The name of the property to fetchReturn ValueThe result is a Python object converted from a COM variant. It + typing.Any:The name of the property to fetchReturn ValueThe result is a Python object converted from a COM variant. It may be an array, or any types supported by COM variant. - + """ pass @@ -11808,7 +11812,7 @@ Args: Returns: None - + """ pass @@ -11823,11 +11827,11 @@ Args: Returns: - typing.Any:The name of the property to fetchReturn ValueThe result is a Python object converted from a COM variant. It + typing.Any:The name of the property to fetchReturn ValueThe result is a Python object converted from a COM variant. It may be an array, or any types supported by COM variant. - + """ pass @@ -11844,7 +11848,7 @@ Args: Returns: None - + """ pass @@ -11868,7 +11872,7 @@ Args: Returns: PyIDispatch - + """ pass @@ -11884,7 +11888,7 @@ Args: Returns: typing.Any - + """ pass @@ -11900,7 +11904,7 @@ Args: Returns: typing.Any - + """ pass @@ -11916,7 +11920,7 @@ Args: Returns: None - + """ pass @@ -11932,7 +11936,7 @@ Args: Returns: typing.Any - + """ pass @@ -11948,7 +11952,7 @@ Args: Returns: None - + """ pass @@ -11971,7 +11975,7 @@ Args: Returns: typing.Any - + """ pass @@ -11987,7 +11991,7 @@ Args: Returns: None - + """ pass @@ -12003,7 +12007,7 @@ Args: Returns: typing.Any - + """ pass @@ -12019,7 +12023,7 @@ Args: Returns: None - + """ pass @@ -12035,7 +12039,7 @@ Args: Returns: typing.Any - + """ pass @@ -12051,7 +12055,7 @@ Args: Returns: typing.Any - + """ pass @@ -12067,7 +12071,7 @@ Args: Returns: typing.Any - + """ pass @@ -12083,7 +12087,7 @@ Args: Returns: None - + """ pass @@ -12099,7 +12103,7 @@ Args: Returns: typing.Any - + """ pass @@ -12115,7 +12119,7 @@ Args: Returns: None - + """ pass @@ -12131,7 +12135,7 @@ Args: Returns: typing.Any - + """ pass @@ -12147,7 +12151,7 @@ Args: Returns: None - + """ pass @@ -12163,7 +12167,7 @@ Args: Returns: typing.Any - + """ pass @@ -12179,7 +12183,7 @@ Args: Returns: None - + """ pass @@ -12195,7 +12199,7 @@ Args: Returns: typing.Any - + """ pass @@ -12211,7 +12215,7 @@ Args: Returns: None - + """ pass @@ -12227,7 +12231,7 @@ Args: Returns: typing.Any - + """ pass @@ -12243,7 +12247,7 @@ Args: Returns: None - + """ pass @@ -12259,7 +12263,7 @@ Args: Returns: typing.Any - + """ pass @@ -12275,7 +12279,7 @@ Args: Returns: None - + """ pass @@ -12291,7 +12295,7 @@ Args: Returns: typing.Any - + """ pass @@ -12307,7 +12311,7 @@ Args: Returns: None - + """ pass @@ -12323,7 +12327,7 @@ Args: Returns: typing.Any - + """ pass @@ -12339,7 +12343,7 @@ Args: Returns: None - + """ pass @@ -12355,7 +12359,7 @@ Args: Returns: typing.Any - + """ pass @@ -12371,7 +12375,7 @@ Args: Returns: None - + """ pass @@ -12387,7 +12391,7 @@ Args: Returns: None - + """ pass @@ -12404,7 +12408,7 @@ Args: Returns: None - + """ pass @@ -12427,7 +12431,7 @@ Args: Returns: None - + """ pass @@ -12444,7 +12448,7 @@ Args: Returns: typing.Any - + """ pass @@ -12461,7 +12465,7 @@ Args: Returns: None - + """ pass @@ -12479,7 +12483,7 @@ Returns: typing.Any:Use 0 if passed in Return ValueReturns one of the WPSTYLE_* values - + """ pass @@ -12496,7 +12500,7 @@ Args: Returns: None - + """ pass @@ -12515,7 +12519,7 @@ Returns: None:Use 0 if passed in Return ValueReturns a unicode string containing decimal values representing the pattern - + """ pass @@ -12532,7 +12536,7 @@ Args: Returns: None - + """ pass @@ -12552,7 +12556,7 @@ Returns: dict = GetDesktopItemOptions()Returns options for Active Desktop. Return ValueReturns a COMPONENTSOPT dictionary - + """ pass @@ -12569,7 +12573,7 @@ Args: Returns: None - + """ pass @@ -12586,7 +12590,7 @@ Args: Returns: None - + """ pass @@ -12604,7 +12608,7 @@ Args: Returns: None - + """ pass @@ -12621,7 +12625,7 @@ Args: Returns: None - + """ pass @@ -12638,7 +12642,7 @@ Args: Returns: None - + """ pass @@ -12654,7 +12658,7 @@ Args: Returns: None - + """ pass @@ -12673,7 +12677,7 @@ Returns: typing.Any:Use 0 if passed in Return ValueReturns a COMPONENT dictionary describing the item - + """ pass @@ -12692,7 +12696,7 @@ Returns: typing.Any:Use 0 if passed in Return ValueReturns a COMPONENT dictionary - + """ pass @@ -12710,7 +12714,7 @@ Args: Returns: None - + """ pass @@ -12729,7 +12733,7 @@ Args: Returns: None - + """ pass @@ -12748,7 +12752,7 @@ Returns: typing.Any:Use 0 if passed in Return ValueReturns a COMPONENT dictionary - + """ pass @@ -12771,7 +12775,7 @@ Args: Returns: None - + """ pass @@ -12785,7 +12789,7 @@ class PyIActiveScriptDebug(object): def GetScriptTextAttributes(self,pstrCode:'str',pstrDelimiter:'str',dwFlags:'typing.Any') -> 'typing.Tuple[typing.Any, ...]': """ - Returns the text attributes for an arbitrary block + Returns the text attributes for an arbitrary block of script text. @@ -12798,7 +12802,7 @@ Args: Returns: typing.Tuple[typing.Any, ...] - + """ pass @@ -12816,7 +12820,7 @@ Args: Returns: None - + """ pass @@ -12834,7 +12838,7 @@ Args: Returns: None - + """ pass @@ -12857,7 +12861,7 @@ Args: Returns: None - + """ pass @@ -12873,7 +12877,7 @@ Args: Returns: None - + """ pass @@ -12889,7 +12893,7 @@ Args: Returns: None - + """ pass @@ -12912,7 +12916,7 @@ Args: Returns: None - + """ pass @@ -12928,7 +12932,7 @@ Args: Returns: None - + """ pass @@ -12959,7 +12963,7 @@ Args: Returns: None - + """ pass @@ -12982,7 +12986,7 @@ Args: Returns: typing.Any - + """ pass @@ -12998,7 +13002,7 @@ Args: Returns: typing.Any - + """ pass @@ -13014,7 +13018,7 @@ Args: Returns: typing.Any - + """ pass @@ -13030,7 +13034,7 @@ Args: Returns: typing.Any - + """ pass @@ -13046,7 +13050,7 @@ Args: Returns: typing.Any - + """ pass @@ -13062,7 +13066,7 @@ Args: Returns: typing.Any - + """ pass @@ -13078,7 +13082,7 @@ Args: Returns: typing.Any - + """ pass @@ -13094,7 +13098,7 @@ Args: Returns: typing.Any - + """ pass @@ -13119,7 +13123,7 @@ Args: Returns: None - + """ pass @@ -13135,7 +13139,7 @@ Args: Returns: None - + """ pass @@ -13151,14 +13155,14 @@ Args: Returns: None - + """ pass def OnScriptErrorDebug(self,) -> 'typing.Tuple[typing.Any, typing.Any]': """ - Allows a smart host to control the handling of runtime + Allows a smart host to control the handling of runtime errors @@ -13170,12 +13174,12 @@ Returns: typing.Tuple[typing.Any, typing.Any]:PyIActiveScriptSiteDebug.OnScriptErrorDebug -int, int = OnScriptErrorDebug()Allows a smart host to control the handling of runtime +int, int = OnScriptErrorDebug()Allows a smart host to control the handling of runtime errors Return ValueThe result is a tuple of (bCallDebugger, bCallOnScriptErrorWhenContinuing) - + """ pass @@ -13201,7 +13205,7 @@ Args: Returns: None - + """ pass @@ -13219,7 +13223,7 @@ Args: Returns: typing.Any - + """ pass @@ -13239,7 +13243,7 @@ Returns: typing.Any:Reserved - must be zero. Return ValueThe result is set to TRUE if the two entry identifiers refer to the same object, and FALSE otherwise. - + """ pass @@ -13262,7 +13266,7 @@ Args: Returns: None - + """ pass @@ -13281,7 +13285,7 @@ Args: Returns: None - + """ pass @@ -13297,7 +13301,7 @@ Args: Returns: None - + """ pass @@ -13315,7 +13319,7 @@ Args: Returns: None - + """ pass @@ -13331,7 +13335,7 @@ Args: Returns: None - + """ pass @@ -13348,7 +13352,7 @@ Args: Returns: None - + """ pass @@ -13371,7 +13375,7 @@ Args: Returns: None - + """ pass @@ -13387,7 +13391,7 @@ Args: Returns: None - + """ pass @@ -13403,7 +13407,7 @@ Args: Returns: None - + """ pass @@ -13426,7 +13430,7 @@ Args: Returns: None - + """ pass @@ -13444,7 +13448,7 @@ Args: Returns: PyIEnumObjects - + """ pass @@ -13467,7 +13471,7 @@ Args: Returns: None - + """ pass @@ -13483,7 +13487,7 @@ Args: Returns: typing.Any - + """ pass @@ -13499,7 +13503,7 @@ Args: Returns: None - + """ pass @@ -13515,7 +13519,7 @@ Args: Returns: None - + """ pass @@ -13533,7 +13537,7 @@ Args: Returns: None - + """ pass @@ -13557,7 +13561,7 @@ Args: Returns: typing.Any - + """ pass @@ -13571,7 +13575,7 @@ class PyIBindCtx(object): def GetRunningObjectTable(self,) -> 'PyIRunningObjectTable': """ - Retrieves an object interfacing to the Running + Retrieves an object interfacing to the Running Object Table. @@ -13582,7 +13586,7 @@ Args: Returns: PyIRunningObjectTable - + """ pass @@ -13598,7 +13602,7 @@ Args: Returns: PyBIND_OPTS - + """ pass @@ -13614,7 +13618,7 @@ Args: Returns: None - + """ pass @@ -13631,7 +13635,7 @@ Args: Returns: None - + """ pass @@ -13647,7 +13651,7 @@ Args: Returns: None - + """ pass @@ -13663,7 +13667,7 @@ Args: Returns: PyIUnknown - + """ pass @@ -13679,7 +13683,7 @@ Args: Returns: PyIEnumString - + """ pass @@ -13702,7 +13706,7 @@ Args: Returns: None - + """ pass @@ -13725,7 +13729,7 @@ Args: Returns: None - + """ pass @@ -13745,7 +13749,7 @@ Returns: int = TestCancel()Checks if a request has been made to cancel a call Return ValueCan return RPC_S_CALLPENDING or RPC_E_CALL_CANCELED - + """ pass @@ -13759,7 +13763,7 @@ class PyICatInformation(object): def EnumCategories(self,lcid:'typing.Any'=0) -> 'PyIEnumCATEGORYINFO': """ - Returns an enumerator for the component categories + Returns an enumerator for the component categories registered on the system. @@ -13770,14 +13774,14 @@ Args: Returns: PyIEnumCATEGORYINFO - + """ pass def GetCategoryDesc(self,lcid:'typing.Any'=0) -> 'str': """ - Retrieves the localized description string for a specific category + Retrieves the localized description string for a specific category ID. @@ -13788,14 +13792,14 @@ Args: Returns: str - + """ pass def EnumClassesOfCategories(self,listIIdImplemented:'typing.List[PyIID]'=None,listIIdRequired:'typing.Any'=None) -> 'PyIEnumGUID': """ - Returns an enumerator over the classes that + Returns an enumerator over the classes that implement one or more interfaces. @@ -13807,7 +13811,7 @@ Args: Returns: PyIEnumGUID - + """ pass @@ -13821,7 +13825,7 @@ class PyICatRegister(object): def RegisterCategories(self,arg:'typing.List[typing.Tuple[PyIID, typing.Any, str]]') -> 'None': """ - Registers one or more component categories. Each component category + Registers one or more component categories. Each component category consists of a CATID and a list of locale-dependent description strings. @@ -13832,7 +13836,7 @@ Args: Returns: None - + """ pass @@ -13848,14 +13852,14 @@ Args: Returns: None - + """ pass def RegisterClassImplCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': """ - Registers the class as implementing one or more component + Registers the class as implementing one or more component categories. @@ -13867,14 +13871,14 @@ Args: Returns: None - + """ pass def UnRegisterClassImplCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': """ - Unregisters the class as implementing one or more component + Unregisters the class as implementing one or more component categories. @@ -13886,14 +13890,14 @@ Args: Returns: None - + """ pass def RegisterClassReqCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': """ - Registers the class as requiring one or more component + Registers the class as requiring one or more component categories. @@ -13905,14 +13909,14 @@ Args: Returns: None - + """ pass def UnRegisterClassReqCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': """ - Unregisters the class as requiring one or more component + Unregisters the class as requiring one or more component categories. @@ -13924,7 +13928,7 @@ Args: Returns: None - + """ pass @@ -13947,7 +13951,7 @@ Args: Returns: None - + """ pass @@ -13963,7 +13967,7 @@ Args: Returns: None - + """ pass @@ -13979,7 +13983,7 @@ Args: Returns: None - + """ pass @@ -13995,7 +13999,7 @@ Args: Returns: None - + """ pass @@ -14011,7 +14015,7 @@ Args: Returns: None - + """ pass @@ -14028,7 +14032,7 @@ Args: Returns: None - + """ pass @@ -14051,18 +14055,18 @@ Args: Returns: - PyIUnknown:The IID of the resultant object.Return ValueThe result object will always be derived from PyIUnknown, but will be of the + PyIUnknown:The IID of the resultant object.Return ValueThe result object will always be derived from PyIUnknown, but will be of the type specified by iid. - + """ pass def LockServer(self,bInc:'typing.Any') -> 'None': """ - Called by the client of a class object to keep a server open in memory, + Called by the client of a class object to keep a server open in memory, allowing instances to be created more quickly. @@ -14073,7 +14077,7 @@ Args: Returns: None - + """ pass @@ -14096,7 +14100,7 @@ Args: Returns: typing.Any - + """ pass @@ -14119,7 +14123,7 @@ Args: Returns: None - + """ pass @@ -14135,7 +14139,7 @@ Args: Returns: PyIUnknown - + """ pass @@ -14158,7 +14162,7 @@ Args: Returns: None - + """ pass @@ -14174,7 +14178,7 @@ Args: Returns: None - + """ pass @@ -14191,7 +14195,7 @@ Args: Returns: None - + """ pass @@ -14205,7 +14209,7 @@ class PyIConnectionPoint(object): def GetConnectionInterface(self,) -> 'PyIID': """ - Retrieves the IID of the interface represented by the + Retrieves the IID of the interface represented by the connection point. @@ -14216,14 +14220,14 @@ Args: Returns: PyIID - + """ pass def GetConnectionPointContainer(self,) -> 'PyIConnectionPointContainer': """ - Gets the connection point + Gets the connection point container for the object. @@ -14234,14 +14238,14 @@ Args: Returns: PyIConnectionPointContainer - + """ pass def Advise(self,unk:'PyIUnknown') -> 'typing.Any': """ - Establishes a connection between the connection point object and the client's + Establishes a connection between the connection point object and the client's sink. @@ -14253,14 +14257,14 @@ Returns: typing.Any:The client's advise sinkReturn ValueThe result is the connection point identifier used by PyIConnectionPoint::Unadvise - + """ pass def Unadvise(self,cookie:'typing.Any') -> 'None': """ - Terminates an advisory connection previously established through + Terminates an advisory connection previously established through IConnectionPoint::Advise. The dwCookie parameter identifies the connection to terminate. @@ -14271,14 +14275,14 @@ Args: Returns: None - + """ pass def EnumConnections(self,) -> 'PyIEnumConnections': """ - Creates an enumerator to iterate through the + Creates an enumerator to iterate through the connections for the connection point @@ -14289,7 +14293,7 @@ Args: Returns: PyIEnumConnections - + """ pass @@ -14303,9 +14307,9 @@ class PyIConnectionPointContainer(object): def EnumConnectionPoints(self,) -> 'PyIEnumConnectionPoints': """ - Creates an enumerator object + Creates an enumerator object -to iterate through all the connection points supported in the connectable object, one connection point per outgoing +to iterate through all the connection points supported in the connectable object, one connection point per outgoing IID. @@ -14316,14 +14320,14 @@ Args: Returns: PyIEnumConnectionPoints - + """ pass def FindConnectionPoint(self,iid:'PyIID') -> 'PyIConnectionPoint': """ - Finds a connection point for the + Finds a connection point for the given IID @@ -14334,7 +14338,7 @@ Args: Returns: PyIConnectionPoint - + """ pass @@ -14359,7 +14363,7 @@ Args: Returns: None - + """ pass @@ -14375,7 +14379,7 @@ Args: Returns: None - + """ pass @@ -14392,7 +14396,7 @@ Returns: typing.Tuple[typing.Any, PyIUnknown]:GUID that identifies a context propertyReturn ValueReturns flags (CPFLAGS is reserved, no defined values) and the IUnknown interface set for the property - + """ pass @@ -14408,7 +14412,7 @@ Args: Returns: PyIEnumContextProps - + """ pass @@ -14435,7 +14439,7 @@ Args: Returns: typing.Any - + """ pass @@ -14451,7 +14455,7 @@ Args: Returns: None - + """ pass @@ -14469,7 +14473,7 @@ Args: Returns: typing.Any - + """ pass @@ -14498,7 +14502,7 @@ Args: Returns: None - + """ pass @@ -14527,7 +14531,7 @@ Args: Returns: None - + """ pass @@ -14550,7 +14554,7 @@ Args: Returns: None - + """ pass @@ -14566,7 +14570,7 @@ Args: Returns: None - + """ pass @@ -14582,7 +14586,7 @@ Args: Returns: None - + """ pass @@ -14598,7 +14602,7 @@ Args: Returns: None - + """ pass @@ -14615,7 +14619,7 @@ Args: Returns: None - + """ pass @@ -14631,7 +14635,7 @@ Args: Returns: None - + """ pass @@ -14647,7 +14651,7 @@ Args: Returns: None - + """ pass @@ -14664,7 +14668,7 @@ Args: Returns: None - + """ pass @@ -14681,7 +14685,7 @@ Args: Returns: None - + """ pass @@ -14697,7 +14701,7 @@ Args: Returns: None - + """ pass @@ -14713,7 +14717,7 @@ Args: Returns: None - + """ pass @@ -14729,7 +14733,7 @@ Args: Returns: None - + """ pass @@ -14746,7 +14750,7 @@ Args: Returns: None - + """ pass @@ -14763,7 +14767,7 @@ Args: Returns: None - + """ pass @@ -14779,7 +14783,7 @@ Args: Returns: None - + """ pass @@ -14797,7 +14801,7 @@ Args: Returns: None - + """ pass @@ -14814,7 +14818,7 @@ Args: Returns: None - + """ pass @@ -14831,7 +14835,7 @@ Args: Returns: None - + """ pass @@ -14848,7 +14852,7 @@ Args: Returns: None - + """ pass @@ -14865,7 +14869,7 @@ Args: Returns: None - + """ pass @@ -14882,7 +14886,7 @@ Args: Returns: None - + """ pass @@ -14898,7 +14902,7 @@ Args: Returns: None - + """ pass @@ -14921,7 +14925,7 @@ Args: Returns: None - + """ pass @@ -14937,7 +14941,7 @@ Args: Returns: None - + """ pass @@ -14954,7 +14958,7 @@ Args: Returns: None - + """ pass @@ -14970,7 +14974,7 @@ Args: Returns: None - + """ pass @@ -14986,7 +14990,7 @@ Args: Returns: None - + """ pass @@ -15002,7 +15006,7 @@ Args: Returns: None - + """ pass @@ -15018,7 +15022,7 @@ Args: Returns: None - + """ pass @@ -15034,7 +15038,7 @@ Args: Returns: None - + """ pass @@ -15050,7 +15054,7 @@ Args: Returns: None - + """ pass @@ -15066,7 +15070,7 @@ Args: Returns: None - + """ pass @@ -15089,7 +15093,7 @@ Args: Returns: None - + """ pass @@ -15105,7 +15109,7 @@ Args: Returns: None - + """ pass @@ -15122,7 +15126,7 @@ Args: Returns: None - + """ pass @@ -15138,7 +15142,7 @@ Args: Returns: None - + """ pass @@ -15154,7 +15158,7 @@ Args: Returns: None - + """ pass @@ -15170,7 +15174,7 @@ Args: Returns: None - + """ pass @@ -15186,7 +15190,7 @@ Args: Returns: None - + """ pass @@ -15202,7 +15206,7 @@ Args: Returns: None - + """ pass @@ -15218,7 +15222,7 @@ Args: Returns: None - + """ pass @@ -15234,7 +15238,7 @@ Args: Returns: None - + """ pass @@ -15264,14 +15268,14 @@ Args: Returns: None - + """ pass def BeginList(self,riid:'PyIID') -> 'typing.Tuple[typing.Any, PyIObjectArray]': """ - Clears the jump list and prepares it to be + Clears the jump list and prepares it to be repopulated @@ -15284,7 +15288,7 @@ Returns: typing.Tuple[typing.Any, PyIObjectArray]:The interface to return Return ValueReturns the number of slots and a collection of all destinations removed from the jump list - + """ pass @@ -15301,7 +15305,7 @@ Args: Returns: None - + """ pass @@ -15317,7 +15321,7 @@ Args: Returns: None - + """ pass @@ -15333,7 +15337,7 @@ Args: Returns: None - + """ pass @@ -15349,14 +15353,14 @@ Args: Returns: None - + """ pass def GetRemovedDestinations(self,riid:'PyIID') -> 'PyIObjectArray': """ - Returns all the items removed from the + Returns all the items removed from the jump list @@ -15367,14 +15371,14 @@ Args: Returns: PyIObjectArray - + """ pass def DeleteList(self,AppID:'typing.Any'=None) -> 'None': """ - Removes any customization, leaving only the system-maintained Recent + Removes any customization, leaving only the system-maintained Recent and Frequent lists @@ -15385,7 +15389,7 @@ Args: Returns: None - + """ pass @@ -15401,13 +15405,13 @@ Args: Returns: None - + """ pass class PyIDL(object): - """A Python representation of an IDL. Implemented as a sequence of Python strings. + """A Python representation of an IDL. Implemented as a sequence of Python strings. FALSE*/, UINT *pcb /* = NULL */)""" @@ -15433,7 +15437,7 @@ Args: Returns: PySTGMEDIUM - + """ pass @@ -15449,7 +15453,7 @@ Args: Returns: PySTGMEDIUM - + """ pass @@ -15464,18 +15468,18 @@ Args: Returns: - None:Tuple representing a FORMATETC struct describing how the data should be + None:Tuple representing a FORMATETC struct describing how the data should be returnedReturn ValueReturns None if the object supports the specified format, otherwise an error is raised. - + """ pass def GetCanonicalFormatEtc(self,pformatectIn:'PyFORMATETC') -> 'PyFORMATETC': """ - Transforms a FORMATECT data description into a general + Transforms a FORMATECT data description into a general format that the object supports @@ -15486,7 +15490,7 @@ Args: Returns: PyFORMATETC - + """ pass @@ -15504,14 +15508,14 @@ Args: Returns: None - + """ pass def EnumFormatEtc(self,dwDirection:'typing.Any') -> 'PyIEnumFORMATETC': """ - Returns an enumerator to list the data formats that the + Returns an enumerator to list the data formats that the object supports. @@ -15522,14 +15526,14 @@ Args: Returns: PyIEnumFORMATETC - + """ pass def DAdvise(self,pformatetc:'PyFORMATETC',advf:'typing.Any',pAdvSink:'typing.Any') -> 'typing.Any': """ - Connects the object to an interface that will receive notifications when its data + Connects the object to an interface that will receive notifications when its data changes @@ -15543,7 +15547,7 @@ Returns: typing.Any:Currently this interface is not wrapped.Return ValueReturns a unique number that is used to identify the connection - + """ pass @@ -15559,7 +15563,7 @@ Args: Returns: None - + """ pass @@ -15575,7 +15579,7 @@ Args: Returns: typing.Any - + """ pass @@ -15598,14 +15602,14 @@ Args: Returns: None - + """ pass def StepOutComplete(self,) -> 'None': """ - Called by language engines, in single step mode, just before they + Called by language engines, in single step mode, just before they return to their caller. @@ -15616,14 +15620,14 @@ Args: Returns: None - + """ pass def DebugOutput(self,pstr:'typing.Any') -> 'None': """ - Causes the given string to be displayed by the debugger IDE, normally in + Causes the given string to be displayed by the debugger IDE, normally in an output window. @@ -15634,14 +15638,14 @@ Args: Returns: None - + """ pass def StartDebugSession(self,) -> 'None': """ - Causes a default debugger IDE to be started and a debug session to + Causes a default debugger IDE to be started and a debug session to be attached to this application if one does not already exist. @@ -15652,14 +15656,14 @@ Args: Returns: None - + """ pass def HandleBreakPoint(self,br:'typing.Any') -> 'typing.Any': """ - Called by the language engine in the context of a thread that has + Called by the language engine in the context of a thread that has hit a breakpoint. @@ -15671,18 +15675,18 @@ Returns: typing.Any:Break reason - one of the BREAKREASON_* constants.Comments -This method causes the current thread to block and a notification of the breakpoint +This method causes the current thread to block and a notification of the breakpoint -to be sent to the debugger IDE. When the debugger IDE resumes the application this +to be sent to the debugger IDE. When the debugger IDE resumes the application this method returns with the action to be taken. -Note: While in the breakpoint the language engine may be called in this thread to do +Note: While in the breakpoint the language engine may be called in this thread to do various things such as enumerating stack frames or evaluating expressions. Return ValueThe result is the break resume action - one of the BREAKRESUMEACTION contsants. - + """ pass @@ -15698,7 +15702,7 @@ Args: Returns: None - + """ pass @@ -15714,14 +15718,14 @@ Args: Returns: typing.Any - + """ pass def GetCurrentThread(self,) -> 'PyIDebugApplicationThread': """ - Returns the application thread object + Returns the application thread object associated with the currently running thread. @@ -15732,7 +15736,7 @@ Args: Returns: PyIDebugApplicationThread - + """ pass @@ -15748,7 +15752,7 @@ Args: Returns: None - + """ pass @@ -15765,14 +15769,14 @@ Returns: typing.Any:Description for pdsfsComments -Generally called by a language engine +Generally called by a language engine -to expose its stack frames to the debugger. It is possible for other entities to +to expose its stack frames to the debugger. It is possible for other entities to expose stack frames. Return ValueThe result is an integer cookie, to be passed to PyIDebugApplication::RemoveStackFrameSniffer - + """ pass @@ -15788,14 +15792,14 @@ Args: Returns: None - + """ pass def QueryCurrentThreadIsDebuggerThread(self,) -> 'None': """ - Determines if the current running thread is the + Determines if the current running thread is the debugger thread. @@ -15806,21 +15810,21 @@ Args: Returns: None:PyIDebugApplication.QueryCurrentThreadIsDebuggerThread -QueryCurrentThreadIsDebuggerThread()Determines if the current running thread is the +QueryCurrentThreadIsDebuggerThread()Determines if the current running thread is the debugger thread. -Return ValueReturns S_OK if the current running thread is the debugger thread. +Return ValueReturns S_OK if the current running thread is the debugger thread. Otherwise, returns S_FALSE. - + """ pass def SynchronousCallInDebuggerThread(self,pptc:'typing.Any',dwParam1:'typing.Any',dwParam2:'typing.Any',dwParam3:'typing.Any') -> 'None': """ - Provides a mechanism for the caller to run code in the + Provides a mechanism for the caller to run code in the debugger thread. @@ -15834,14 +15838,14 @@ Args: Returns: None - + """ pass def CreateApplicationNode(self,) -> 'PyIDebugApplicationNode': """ - Creates a new application node which + Creates a new application node which is associated with a specific document provider. @@ -15852,7 +15856,7 @@ Args: Returns: PyIDebugApplicationNode - + """ pass @@ -15869,7 +15873,7 @@ Args: Returns: None - + """ pass @@ -15886,7 +15890,7 @@ Args: Returns: None - + """ pass @@ -15902,7 +15906,7 @@ Args: Returns: None - + """ pass @@ -15918,7 +15922,7 @@ Args: Returns: None - + """ pass @@ -15934,14 +15938,14 @@ Args: Returns: None - + """ pass def RemoveGlobalExpressionContextProvider(self,dwCookie:'typing.Any') -> 'None': """ - Description of + Description of RemoveGlobalExpressionContextProvider. @@ -15952,7 +15956,7 @@ Args: Returns: None - + """ pass @@ -15975,7 +15979,7 @@ Args: Returns: None - + """ pass @@ -15991,7 +15995,7 @@ Args: Returns: PyIDebugApplicationNode - + """ pass @@ -16007,7 +16011,7 @@ Args: Returns: None - + """ pass @@ -16023,7 +16027,7 @@ Args: Returns: None - + """ pass @@ -16039,7 +16043,7 @@ Args: Returns: None - + """ pass @@ -16055,7 +16059,7 @@ Args: Returns: None - + """ pass @@ -16078,7 +16082,7 @@ Args: Returns: None - + """ pass @@ -16094,7 +16098,7 @@ Args: Returns: None - + """ pass @@ -16110,7 +16114,7 @@ Args: Returns: None - + """ pass @@ -16126,7 +16130,7 @@ Args: Returns: None - + """ pass @@ -16152,7 +16156,7 @@ Args: Returns: None - + """ pass @@ -16168,7 +16172,7 @@ Args: Returns: None - + """ pass @@ -16184,7 +16188,7 @@ Args: Returns: None - + """ pass @@ -16207,7 +16211,7 @@ Args: Returns: None - + """ pass @@ -16223,7 +16227,7 @@ Args: Returns: None - + """ pass @@ -16253,7 +16257,7 @@ Args: Returns: None - + """ pass @@ -16269,7 +16273,7 @@ Args: Returns: None - + """ pass @@ -16295,7 +16299,7 @@ Args: Returns: None - + """ pass @@ -16311,7 +16315,7 @@ Args: Returns: None - + """ pass @@ -16327,7 +16331,7 @@ Args: Returns: None - + """ pass @@ -16343,7 +16347,7 @@ Args: Returns: None - + """ pass @@ -16359,7 +16363,7 @@ Args: Returns: None - + """ pass @@ -16375,7 +16379,7 @@ Args: Returns: None - + """ pass @@ -16392,7 +16396,7 @@ Args: Returns: None - + """ pass @@ -16411,7 +16415,7 @@ Args: Returns: None - + """ pass @@ -16427,7 +16431,7 @@ Args: Returns: None - + """ pass @@ -16444,7 +16448,7 @@ Args: Returns: None - + """ pass @@ -16460,7 +16464,7 @@ Args: Returns: None - + """ pass @@ -16476,7 +16480,7 @@ Args: Returns: None - + """ pass @@ -16492,7 +16496,7 @@ Args: Returns: None - + """ pass @@ -16508,7 +16512,7 @@ Args: Returns: None - + """ pass @@ -16524,7 +16528,7 @@ Args: Returns: None - + """ pass @@ -16541,7 +16545,7 @@ Args: Returns: None - + """ pass @@ -16557,7 +16561,7 @@ Args: Returns: None - + """ pass @@ -16573,7 +16577,7 @@ Args: Returns: None - + """ pass @@ -16597,7 +16601,7 @@ Args: Returns: None - + """ pass @@ -16615,7 +16619,7 @@ Args: Returns: None - + """ pass @@ -16631,7 +16635,7 @@ Args: Returns: None - + """ pass @@ -16647,7 +16651,7 @@ Args: Returns: None - + """ pass @@ -16663,7 +16667,7 @@ Args: Returns: None - + """ pass @@ -16679,7 +16683,7 @@ Args: Returns: None - + """ pass @@ -16702,7 +16706,7 @@ Args: Returns: None - + """ pass @@ -16718,7 +16722,7 @@ Args: Returns: PyIID - + """ pass @@ -16732,7 +16736,7 @@ class PyIDebugDocumentProvider(object): def GetDocument(self,) -> 'PyIDebugDocument': """ - Causes the document to be instantiated if it does + Causes the document to be instantiated if it does not already exist. @@ -16743,7 +16747,7 @@ Args: Returns: PyIDebugDocument - + """ pass @@ -16766,7 +16770,7 @@ Args: Returns: None - + """ pass @@ -16782,7 +16786,7 @@ Args: Returns: None - + """ pass @@ -16798,7 +16802,7 @@ Args: Returns: None - + """ pass @@ -16814,7 +16818,7 @@ Args: Returns: None - + """ pass @@ -16832,7 +16836,7 @@ Args: Returns: None - + """ pass @@ -16848,7 +16852,7 @@ Args: Returns: None - + """ pass @@ -16865,7 +16869,7 @@ Args: Returns: None - + """ pass @@ -16890,7 +16894,7 @@ Args: Returns: None - + """ pass @@ -16907,7 +16911,7 @@ Args: Returns: None - + """ pass @@ -16925,7 +16929,7 @@ Args: Returns: None - + """ pass @@ -16948,7 +16952,7 @@ Args: Returns: None - + """ pass @@ -16965,7 +16969,7 @@ Args: Returns: None - + """ pass @@ -16982,7 +16986,7 @@ Args: Returns: None - + """ pass @@ -16999,7 +17003,7 @@ Args: Returns: None - + """ pass @@ -17016,7 +17020,7 @@ Args: Returns: None - + """ pass @@ -17032,7 +17036,7 @@ Args: Returns: None - + """ pass @@ -17055,7 +17059,7 @@ Args: Returns: None - + """ pass @@ -17071,7 +17075,7 @@ Args: Returns: None - + """ pass @@ -17087,7 +17091,7 @@ Args: Returns: None - + """ pass @@ -17110,7 +17114,7 @@ Args: Returns: None - + """ pass @@ -17126,7 +17130,7 @@ Args: Returns: None - + """ pass @@ -17142,7 +17146,7 @@ Args: Returns: None - + """ pass @@ -17158,7 +17162,7 @@ Args: Returns: None - + """ pass @@ -17174,7 +17178,7 @@ Args: Returns: None - + """ pass @@ -17197,7 +17201,7 @@ Args: Returns: None - + """ pass @@ -17223,7 +17227,7 @@ Args: Returns: None - + """ pass @@ -17239,7 +17243,7 @@ Args: Returns: None - + """ pass @@ -17263,7 +17267,7 @@ Args: Returns: None - + """ pass @@ -17279,7 +17283,7 @@ Args: Returns: None - + """ pass @@ -17296,7 +17300,7 @@ Args: Returns: None - + """ pass @@ -17314,7 +17318,7 @@ Args: Returns: None - + """ pass @@ -17330,7 +17334,7 @@ Args: Returns: None - + """ pass @@ -17353,7 +17357,7 @@ Args: Returns: None - + """ pass @@ -17376,14 +17380,14 @@ Args: Returns: None - + """ pass def GetDescriptionString(self,fLong:'typing.Any') -> 'typing.Any': """ - Returns a short or long textual description of the + Returns a short or long textual description of the stack frame. @@ -17394,14 +17398,14 @@ Args: Returns: typing.Any - + """ pass def GetLanguageString(self,fLong:'typing.Any') -> 'typing.Any': """ - Returns a short or long textual description of the + Returns a short or long textual description of the language. @@ -17412,14 +17416,14 @@ Args: Returns: typing.Any - + """ pass def GetThread(self,) -> 'PyIDebugApplicationThread': """ - Returns the thread associated with this stack + Returns the thread associated with this stack frame. @@ -17430,7 +17434,7 @@ Args: Returns: PyIDebugApplicationThread - + """ pass @@ -17453,7 +17457,7 @@ Args: Returns: None - + """ pass @@ -17476,7 +17480,7 @@ Args: Returns: None - + """ pass @@ -17499,7 +17503,7 @@ Args: Returns: None - + """ pass @@ -17515,7 +17519,7 @@ Args: Returns: None - + """ pass @@ -17531,7 +17535,7 @@ Args: Returns: None - + """ pass @@ -17554,7 +17558,7 @@ Args: Returns: None - + """ pass @@ -17570,7 +17574,7 @@ Args: Returns: None - + """ pass @@ -17587,7 +17591,7 @@ Args: Returns: None - + """ pass @@ -17604,7 +17608,7 @@ Args: Returns: None - + """ pass @@ -17621,7 +17625,7 @@ Args: Returns: None - + """ pass @@ -17638,7 +17642,7 @@ Args: Returns: None - + """ pass @@ -17661,14 +17665,14 @@ Args: Returns: None - + """ pass def SetCooperativeLevel(self,hwnd:'typing.Any',level:'typing.Any') -> 'None': """ - The IDirectSound::SetCooperativeLevel method sets the cooperative level + The IDirectSound::SetCooperativeLevel method sets the cooperative level of the application for this sound device. @@ -17680,14 +17684,14 @@ Args: Returns: None - + """ pass def CreateSoundBuffer(self,lpDSCBufferDesc:'PyDSCBUFFERDESC',unk:'typing.Any'=None) -> 'None': """ - The IDirectSound::CreateSoundBuffer method creates a DirectSoundBuffer + The IDirectSound::CreateSoundBuffer method creates a DirectSoundBuffer object to hold a sequence of audio samples. @@ -17699,7 +17703,7 @@ Args: Returns: None - + """ pass @@ -17715,14 +17719,14 @@ Args: Returns: None - + """ pass def Compact(self,) -> 'None': """ - The Compact method moves the unused portions of on-board sound memory, if any, to a + The Compact method moves the unused portions of on-board sound memory, if any, to a contiguous block so that the largest portion of free memory will be available. @@ -17733,7 +17737,7 @@ Args: Returns: None - + """ pass @@ -17756,7 +17760,7 @@ Args: Returns: None - + """ pass @@ -17772,14 +17776,14 @@ Args: Returns: None - + """ pass def GetCaps(self,) -> 'None': """ - Retrieves the capabilities of the DirectSoundBuffer object as a DSBCAPS + Retrieves the capabilities of the DirectSoundBuffer object as a DSBCAPS object. @@ -17790,14 +17794,14 @@ Args: Returns: None - + """ pass def Restore(self,) -> 'None': """ - Restores the memory allocation for a lost sound buffer for the specified + Restores the memory allocation for a lost sound buffer for the specified DirectSoundBuffer object. @@ -17808,7 +17812,7 @@ Args: Returns: None - + """ pass @@ -17824,7 +17828,7 @@ Args: Returns: None - + """ pass @@ -17840,7 +17844,7 @@ Args: Returns: None - + """ pass @@ -17856,7 +17860,7 @@ Args: Returns: None - + """ pass @@ -17872,7 +17876,7 @@ Args: Returns: None - + """ pass @@ -17888,7 +17892,7 @@ Args: Returns: None - + """ pass @@ -17904,7 +17908,7 @@ Args: Returns: None - + """ pass @@ -17920,7 +17924,7 @@ Args: Returns: None - + """ pass @@ -17936,7 +17940,7 @@ Args: Returns: None - + """ pass @@ -17952,7 +17956,7 @@ Args: Returns: None - + """ pass @@ -17968,13 +17972,13 @@ Args: Returns: None - + """ pass class PyIDirectSoundCapture(object): - """The methods of the IDirectSoundCapture interface are used to create sound capture + """The methods of the IDirectSoundCapture interface are used to create sound capture buffers.""" @@ -17993,7 +17997,7 @@ Args: Returns: None - + """ pass @@ -18009,13 +18013,13 @@ Args: Returns: None - + """ pass class PyIDirectSoundCaptureBuffer(object): - """The methods of the IDirectSoundCaptureBuffer interface are used to manipulate + """The methods of the IDirectSoundCaptureBuffer interface are used to manipulate sound capture buffers.""" @@ -18025,7 +18029,7 @@ sound capture buffers.""" def Initialize(self,) -> 'None': """ - Not normally used. Used IDirectSoundCapture.CreateCaptureBuffer + Not normally used. Used IDirectSoundCapture.CreateCaptureBuffer instead. @@ -18036,7 +18040,7 @@ Args: Returns: None - + """ pass @@ -18052,18 +18056,18 @@ Args: Returns: None - + """ pass def GetCurrentPosition(self,) -> 'None': """ - Returns a tuple of the current capture and read position in + Returns a tuple of the current capture and read position in -the buffer. The capture position is ahead of the read position. These positions are not always identical due to +the buffer. The capture position is ahead of the read position. These positions are not always identical due to -possible buffering of captured data either on the physical device or in the host. The data after the read position up +possible buffering of captured data either on the physical device or in the host. The data after the read position up to and including the capture position is not necessarily valid data. @@ -18074,16 +18078,16 @@ Args: Returns: None - + """ pass def Stop(self,) -> 'None': """ - The IDirectSoundCaptureBuffer::Stop method puts the capture buffer into + The IDirectSoundCaptureBuffer::Stop method puts the capture buffer into -the "stop" state and stops capturing data. If the capture buffer is already in the stop state then the method has no +the "stop" state and stops capturing data. If the capture buffer is already in the stop state then the method has no effect. @@ -18094,7 +18098,7 @@ Args: Returns: None - + """ pass @@ -18124,7 +18128,7 @@ Args: Returns: PyADS_OBJECT_INFO - + """ pass @@ -18140,7 +18144,7 @@ Args: Returns: typing.Tuple[PyADS_ATTR_INFO, ...] - + """ pass @@ -18156,7 +18160,7 @@ Args: Returns: typing.Any - + """ pass @@ -18173,7 +18177,7 @@ Args: Returns: PyIDispatch - + """ pass @@ -18189,7 +18193,7 @@ Args: Returns: None - + """ pass @@ -18211,11 +18215,11 @@ Args: Returns: - typing.Tuple[typing.Any, typing.Any, typing.Any]:Return ValueThe result is the hresult of the call, and a list of integer status + typing.Tuple[typing.Any, typing.Any, typing.Any]:Return ValueThe result is the hresult of the call, and a list of integer status codes for each of the preferences set. - + """ pass @@ -18231,11 +18235,11 @@ Args: Returns: - typing.Any:Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle + typing.Any:Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle should be called to close the handle. - + """ pass @@ -18252,7 +18256,7 @@ Returns: typing.Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - + """ pass @@ -18269,7 +18273,7 @@ Returns: typing.Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - + """ pass @@ -18286,7 +18290,7 @@ Returns: typing.Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - + """ pass @@ -18302,7 +18306,7 @@ Args: Returns: None - + """ pass @@ -18318,7 +18322,7 @@ Args: Returns: None - + """ pass @@ -18335,7 +18339,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any] - + """ pass @@ -18354,7 +18358,7 @@ Returns: GetNextColumnName() Return ValueReturns None when the underlying ADSI function return S_ADS_NOMORE_COLUMNS. - + """ pass @@ -18380,11 +18384,11 @@ Args: Returns: - typing.Any:The parameters to pass.Return ValueIf the bResultWanted parameter is False, then the result will be None. + typing.Any:The parameters to pass.Return ValueIf the bResultWanted parameter is False, then the result will be None. Otherwise, the result is determined by the COM object itself (and may still be None) - + """ pass @@ -18405,7 +18409,7 @@ Args: Returns: typing.Any - + """ pass @@ -18425,13 +18429,13 @@ Returns: Comments Currently the LCID can not be specified, and LOCALE_SYSTEM_DEFAULT is used. -Return ValueIf the first parameter is a sequence, the result will be a tuple of integers +Return ValueIf the first parameter is a sequence, the result will be a tuple of integers -for each name in the sequence. If the first parameter is a single string, the result +for each name in the sequence. If the first parameter is a single string, the result is a single integer with the ID of requested item. - + """ pass @@ -18448,7 +18452,7 @@ Args: Returns: PyITypeInfo - + """ pass @@ -18464,7 +18468,7 @@ Args: Returns: typing.Any - + """ pass @@ -18488,7 +18492,7 @@ Args: Returns: typing.Any - + """ pass @@ -18510,7 +18514,7 @@ Args: Returns: typing.Any - + """ pass @@ -18527,7 +18531,7 @@ Args: Returns: None - + """ pass @@ -18543,7 +18547,7 @@ Args: Returns: None - + """ pass @@ -18560,7 +18564,7 @@ Args: Returns: typing.Any - + """ pass @@ -18576,7 +18580,7 @@ Args: Returns: typing.Any - + """ pass @@ -18593,7 +18597,7 @@ Args: Returns: typing.Any - + """ pass @@ -18626,7 +18630,7 @@ Args: Returns: None - + """ pass @@ -18642,7 +18646,7 @@ Args: Returns: None - + """ pass @@ -18662,7 +18666,7 @@ Args: Returns: None - + """ pass @@ -18678,7 +18682,7 @@ Args: Returns: None - + """ pass @@ -18694,7 +18698,7 @@ Args: Returns: None - + """ pass @@ -18710,7 +18714,7 @@ Args: Returns: None - + """ pass @@ -18726,7 +18730,7 @@ Args: Returns: None - + """ pass @@ -18742,7 +18746,7 @@ Args: Returns: None - + """ pass @@ -18760,7 +18764,7 @@ Args: Returns: None - + """ pass @@ -18778,7 +18782,7 @@ Args: Returns: None - + """ pass @@ -18794,7 +18798,7 @@ Args: Returns: None - + """ pass @@ -18810,7 +18814,7 @@ Args: Returns: None - + """ pass @@ -18826,7 +18830,7 @@ Args: Returns: None - + """ pass @@ -18843,7 +18847,7 @@ Args: Returns: None - + """ pass @@ -18859,7 +18863,7 @@ Args: Returns: None - + """ pass @@ -18883,7 +18887,7 @@ Args: Returns: None - + """ pass @@ -18899,7 +18903,7 @@ Args: Returns: None - + """ pass @@ -18924,11 +18928,11 @@ Args: Returns: - typing.Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can + typing.Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can be accepted - + """ pass @@ -18945,11 +18949,11 @@ Args: Returns: - typing.Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the + typing.Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can be accepted at the current position - + """ pass @@ -18965,7 +18969,7 @@ Args: Returns: None - + """ pass @@ -18985,7 +18989,7 @@ Returns: typing.Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return one of the shellcon.DROPEFFECT_* values - + """ pass @@ -19011,7 +19015,7 @@ Args: Returns: None - + """ pass @@ -19029,7 +19033,7 @@ Args: Returns: None - + """ pass @@ -19045,7 +19049,7 @@ Args: Returns: None - + """ pass @@ -19063,7 +19067,7 @@ Args: Returns: None - + """ pass @@ -19089,7 +19093,7 @@ Args: Returns: None - + """ pass @@ -19105,7 +19109,7 @@ Args: Returns: PyIDataObject - + """ pass @@ -19144,7 +19148,7 @@ Args: Returns: None - + """ pass @@ -19164,7 +19168,7 @@ Args: Returns: None - + """ pass @@ -19178,7 +19182,7 @@ class PyIEnumCATEGORYINFO(object): def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[typing.Tuple[PyIID, typing.Any, str], ...]': """ - Retrieves a specified number of items in the + Retrieves a specified number of items in the enumeration sequence. @@ -19189,11 +19193,11 @@ Args: Returns: typing.Tuple[typing.Tuple[PyIID, typing.Any, str], ...]:Number of items to retrieve. -Return ValueThe result is a tuple of (IID object, LCID, string description) tuples, +Return ValueThe result is a tuple of (IID object, LCID, string description) tuples, one for each element returned. - + """ pass @@ -19209,7 +19213,7 @@ Args: Returns: None - + """ pass @@ -19225,14 +19229,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumCATEGORYINFO': """ - Creates another enumerator that contains the same + Creates another enumerator that contains the same enumeration state as the current one @@ -19243,7 +19247,7 @@ Args: Returns: PyIEnumCATEGORYINFO - + """ pass @@ -19257,7 +19261,7 @@ class PyIEnumConnectionPoints(object): def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[PyIConnectionPoint, ...]': """ - Retrieves a specified number of items in the + Retrieves a specified number of items in the enumeration sequence. @@ -19268,7 +19272,7 @@ Args: Returns: typing.Tuple[PyIConnectionPoint, ...] - + """ pass @@ -19284,7 +19288,7 @@ Args: Returns: None - + """ pass @@ -19300,14 +19304,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumConnectionPoints': """ - Creates another enumerator that contains the same + Creates another enumerator that contains the same enumeration state as the current one @@ -19318,7 +19322,7 @@ Args: Returns: PyIEnumConnectionPoints - + """ pass @@ -19341,7 +19345,7 @@ Args: Returns: typing.Any - + """ pass @@ -19357,7 +19361,7 @@ Args: Returns: None - + """ pass @@ -19373,14 +19377,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumConnections': """ - Creates another enumerator that contains the same + Creates another enumerator that contains the same enumeration state as the current one @@ -19391,7 +19395,7 @@ Args: Returns: PyIEnumConnections - + """ pass @@ -19405,7 +19409,7 @@ class PyIEnumContextProps(object): def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[typing.Tuple[PyIID, typing.Any, PyIUnknown], ...]': """ - Retrieves a specified number of items in + Retrieves a specified number of items in the enumeration sequence. @@ -19416,13 +19420,13 @@ Args: Returns: typing.Tuple[typing.Tuple[PyIID, typing.Any, PyIUnknown], ...]:Number of items to retrieve. -Return ValueReturns a tuple of 3-tuples representing ContextProperty structs: +Return ValueReturns a tuple of 3-tuples representing ContextProperty structs: - First item is GUID identifying the property, second is Flags (reserved), third is the interface set as the + First item is GUID identifying the property, second is Flags (reserved), third is the interface set as the property value - + """ pass @@ -19438,7 +19442,7 @@ Args: Returns: None - + """ pass @@ -19454,14 +19458,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumContextProps': """ - Creates another enumerator that contains the same + Creates another enumerator that contains the same enumeration state as the current one @@ -19472,7 +19476,7 @@ Args: Returns: PyIEnumContextProps - + """ pass @@ -19495,7 +19499,7 @@ Args: Returns: typing.Any - + """ pass @@ -19511,7 +19515,7 @@ Args: Returns: None - + """ pass @@ -19527,14 +19531,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumDebugApplicationNodes': """ - Creates another enumerator that + Creates another enumerator that contains the same enumeration state as the current one @@ -19545,7 +19549,7 @@ Args: Returns: PyIEnumDebugApplicationNodes - + """ pass @@ -19568,7 +19572,7 @@ Args: Returns: typing.Any - + """ pass @@ -19584,7 +19588,7 @@ Args: Returns: None - + """ pass @@ -19600,14 +19604,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumDebugCodeContexts': """ - Creates another enumerator that contains the + Creates another enumerator that contains the same enumeration state as the current one @@ -19618,7 +19622,7 @@ Args: Returns: PyIEnumDebugCodeContexts - + """ pass @@ -19632,7 +19636,7 @@ class PyIEnumDebugExpressionContexts(object): def Next(self,num:'typing.Any'=1) -> 'typing.Any': """ - Retrieves a specified number of items in the enumeration + Retrieves a specified number of items in the enumeration sequence. @@ -19643,7 +19647,7 @@ Args: Returns: typing.Any - + """ pass @@ -19659,7 +19663,7 @@ Args: Returns: None - + """ pass @@ -19675,14 +19679,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumDebugExpressionContexts': """ - Creates another enumerator that + Creates another enumerator that contains the same enumeration state as the current one @@ -19693,7 +19697,7 @@ Args: Returns: PyIEnumDebugExpressionContexts - + """ pass @@ -19716,7 +19720,7 @@ Args: Returns: typing.Any - + """ pass @@ -19732,7 +19736,7 @@ Args: Returns: None - + """ pass @@ -19748,14 +19752,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumDebugPropertyInfo': """ - Creates another enumerator that contains the + Creates another enumerator that contains the same enumeration state as the current one @@ -19766,7 +19770,7 @@ Args: Returns: PyIEnumDebugPropertyInfo - + """ pass @@ -19782,7 +19786,7 @@ Args: Returns: typing.Any - + """ pass @@ -19805,7 +19809,7 @@ Args: Returns: typing.Any - + """ pass @@ -19821,7 +19825,7 @@ Args: Returns: None - + """ pass @@ -19837,14 +19841,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumDebugStackFrames': """ - Creates another enumerator that contains the same + Creates another enumerator that contains the same enumeration state as the current one @@ -19855,7 +19859,7 @@ Args: Returns: PyIEnumDebugStackFrames - + """ pass @@ -19878,7 +19882,7 @@ Args: Returns: typing.Any - + """ pass @@ -19894,7 +19898,7 @@ Args: Returns: None - + """ pass @@ -19910,14 +19914,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumExplorerCommand': """ - Creates another enumerator that contains the same + Creates another enumerator that contains the same enumeration state as the current one @@ -19928,7 +19932,7 @@ Args: Returns: PyIEnumExplorerCommand - + """ pass @@ -19951,7 +19955,7 @@ Args: Returns: typing.Any - + """ pass @@ -19967,7 +19971,7 @@ Args: Returns: None - + """ pass @@ -19983,14 +19987,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumFORMATETC': """ - Creates another enumerator that contains the same enumeration + Creates another enumerator that contains the same enumeration state as the current one @@ -20001,7 +20005,7 @@ Args: Returns: PyIEnumFORMATETC - + """ pass @@ -20024,13 +20028,13 @@ Args: Returns: typing.Tuple[PyIID, ...]:Number of items to retrieve. -Return ValueThe result is a tuple of PyIID objects, +Return ValueThe result is a tuple of PyIID objects, -one for each element returned. Note that if zero elements are returned, it is not considered +one for each element returned. Note that if zero elements are returned, it is not considered an error condition - an empty tuple is simply returned. - + """ pass @@ -20046,7 +20050,7 @@ Args: Returns: None - + """ pass @@ -20062,14 +20066,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumGUID': """ - Creates another enumerator that contains the same enumeration state as + Creates another enumerator that contains the same enumeration state as the current one @@ -20080,7 +20084,7 @@ Args: Returns: PyIEnumGUID - + """ pass @@ -20103,7 +20107,7 @@ Args: Returns: typing.Any - + """ pass @@ -20119,7 +20123,7 @@ Args: Returns: None - + """ pass @@ -20135,14 +20139,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumIDList': """ - Creates another enumerator that contains the same enumeration state + Creates another enumerator that contains the same enumeration state as the current one @@ -20153,7 +20157,7 @@ Args: Returns: PyIEnumIDList - + """ pass @@ -20176,13 +20180,13 @@ Args: Returns: PyIMoniker:Number of items to retrieve. -Return ValueThe result is a tuple of PyIID objects, +Return ValueThe result is a tuple of PyIID objects, -one for each element returned. Note that if zero elements are returned, it is not considered +one for each element returned. Note that if zero elements are returned, it is not considered an error condition - an empty tuple is simply returned. - + """ pass @@ -20198,7 +20202,7 @@ Args: Returns: None - + """ pass @@ -20214,14 +20218,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumMoniker': """ - Creates another enumerator that contains the same enumeration state + Creates another enumerator that contains the same enumeration state as the current one @@ -20232,7 +20236,7 @@ Args: Returns: PyIEnumMoniker - + """ pass @@ -20256,7 +20260,7 @@ Args: Returns: typing.Tuple[PyIUnknown, ...] - + """ pass @@ -20272,7 +20276,7 @@ Args: Returns: None - + """ pass @@ -20288,14 +20292,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumObjects': """ - Creates another enumerator that contains the same enumeration state + Creates another enumerator that contains the same enumeration state as the current one @@ -20306,7 +20310,7 @@ Args: Returns: PyIEnumObjects - + """ pass @@ -20320,7 +20324,7 @@ class PyIEnumRemoteDebugApplicationThreads(object): def Next(self,num:'typing.Any'=1) -> 'typing.Any': """ - Retrieves a specified number of items in the enumeration + Retrieves a specified number of items in the enumeration sequence. @@ -20331,7 +20335,7 @@ Args: Returns: typing.Any - + """ pass @@ -20347,7 +20351,7 @@ Args: Returns: None - + """ pass @@ -20363,14 +20367,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumRemoteDebugApplicationThreads': """ - Creates another + Creates another enumerator that contains the same enumeration state as the current one @@ -20381,7 +20385,7 @@ Args: Returns: PyIEnumRemoteDebugApplicationThreads - + """ pass @@ -20395,7 +20399,7 @@ class PyIEnumRemoteDebugApplications(object): def Next(self,num:'typing.Any'=1) -> 'typing.Any': """ - Retrieves a specified number of items in the enumeration + Retrieves a specified number of items in the enumeration sequence. @@ -20406,7 +20410,7 @@ Args: Returns: typing.Any - + """ pass @@ -20422,7 +20426,7 @@ Args: Returns: None - + """ pass @@ -20438,14 +20442,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumRemoteDebugApplications': """ - Creates another enumerator that + Creates another enumerator that contains the same enumeration state as the current one @@ -20456,7 +20460,7 @@ Args: Returns: PyIEnumRemoteDebugApplications - + """ pass @@ -20479,7 +20483,7 @@ Args: Returns: typing.Any - + """ pass @@ -20495,7 +20499,7 @@ Args: Returns: None - + """ pass @@ -20511,14 +20515,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumResources': """ - Creates another enumerator that contains the same enumeration + Creates another enumerator that contains the same enumeration state as the current one @@ -20529,7 +20533,7 @@ Args: Returns: PyIEnumResources - + """ pass @@ -20552,7 +20556,7 @@ Args: Returns: typing.Any - + """ pass @@ -20568,7 +20572,7 @@ Args: Returns: None - + """ pass @@ -20584,14 +20588,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumSTATPROPSETSTG': """ - Creates another enumerator that contains the same + Creates another enumerator that contains the same enumeration state as the current one @@ -20602,7 +20606,7 @@ Args: Returns: PyIEnumSTATPROPSETSTG - + """ pass @@ -20625,7 +20629,7 @@ Args: Returns: typing.Any - + """ pass @@ -20641,7 +20645,7 @@ Args: Returns: None - + """ pass @@ -20657,14 +20661,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumSTATPROPSTG': """ - Creates another enumerator that contains the same + Creates another enumerator that contains the same enumeration state as the current one @@ -20675,7 +20679,7 @@ Args: Returns: PyIEnumSTATPROPSTG - + """ pass @@ -20698,7 +20702,7 @@ Args: Returns: typing.Tuple[STATSTG, ...] - + """ pass @@ -20714,7 +20718,7 @@ Args: Returns: None - + """ pass @@ -20730,14 +20734,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumSTATSTG': """ - Creates another enumerator that contains the same enumeration state + Creates another enumerator that contains the same enumeration state as the current one @@ -20748,7 +20752,7 @@ Args: Returns: PyIEnumSTATSTG - + """ pass @@ -20762,7 +20766,7 @@ class PyIEnumShellItems(object): def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[PyIShellItem, ...]': """ - Retrieves a specified number of items in the enumeration + Retrieves a specified number of items in the enumeration sequence. @@ -20773,7 +20777,7 @@ Args: Returns: typing.Tuple[PyIShellItem, ...] - + """ pass @@ -20789,7 +20793,7 @@ Args: Returns: None - + """ pass @@ -20805,14 +20809,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumShellItems': """ - Creates another enumerator that contains the same enumeration + Creates another enumerator that contains the same enumeration state as the current one @@ -20823,7 +20827,7 @@ Args: Returns: PyIEnumShellItems - + """ pass @@ -20846,7 +20850,7 @@ Args: Returns: typing.Tuple[str, ...] - + """ pass @@ -20862,7 +20866,7 @@ Args: Returns: None - + """ pass @@ -20878,14 +20882,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIEnumString': """ - Creates another enumerator that contains the same enumeration state + Creates another enumerator that contains the same enumeration state as the current one @@ -20896,7 +20900,7 @@ Args: Returns: PyIEnumString - + """ pass @@ -20920,7 +20924,7 @@ Args: Returns: None - + """ pass @@ -20945,7 +20949,7 @@ Args: Returns: None - + """ pass @@ -20961,7 +20965,7 @@ Args: Returns: None - + """ pass @@ -20978,7 +20982,7 @@ Args: Returns: int - + """ pass @@ -20994,7 +20998,7 @@ Args: Returns: None - + """ pass @@ -21010,7 +21014,7 @@ Args: Returns: None - + """ pass @@ -21026,7 +21030,7 @@ Args: Returns: None - + """ pass @@ -21042,7 +21046,7 @@ Args: Returns: typing.Any - + """ pass @@ -21058,7 +21062,7 @@ Args: Returns: None - + """ pass @@ -21074,7 +21078,7 @@ Args: Returns: None - + """ pass @@ -21090,7 +21094,7 @@ Args: Returns: typing.Any - + """ pass @@ -21107,7 +21111,7 @@ Args: Returns: None - + """ pass @@ -21124,7 +21128,7 @@ Args: Returns: None - + """ pass @@ -21141,7 +21145,7 @@ Args: Returns: None - + """ pass @@ -21157,7 +21161,7 @@ Args: Returns: None - + """ pass @@ -21173,7 +21177,7 @@ Args: Returns: PyIUnknown - + """ pass @@ -21196,7 +21200,7 @@ Args: Returns: None - + """ pass @@ -21212,7 +21216,7 @@ Args: Returns: None - + """ pass @@ -21228,7 +21232,7 @@ Args: Returns: None - + """ pass @@ -21244,7 +21248,7 @@ Args: Returns: None - + """ pass @@ -21267,7 +21271,7 @@ Args: Returns: typing.Any - + """ pass @@ -21283,7 +21287,7 @@ Args: Returns: typing.Any - + """ pass @@ -21299,7 +21303,7 @@ Args: Returns: typing.Any - + """ pass @@ -21315,7 +21319,7 @@ Args: Returns: PyIID - + """ pass @@ -21332,7 +21336,7 @@ Args: Returns: typing.Any - + """ pass @@ -21349,7 +21353,7 @@ Args: Returns: None - + """ pass @@ -21365,7 +21369,7 @@ Args: Returns: typing.Any - + """ pass @@ -21381,7 +21385,7 @@ Args: Returns: PyIEnumExplorerCommand - + """ pass @@ -21409,7 +21413,7 @@ class PyIExternalConnection(object): def AddConnection(self,extconn:'typing.Any',reserved:'typing.Any'=0) -> 'typing.Any': """ - Increments an object's count of its strong external connections + Increments an object's count of its strong external connections (links). @@ -21423,14 +21427,14 @@ Returns: typing.Any:A reserved parameter Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - + """ pass def ReleaseConnection(self,extconn:'typing.Any',reserved:'typing.Any',fLastReleaseCloses:'typing.Any') -> 'typing.Any': """ - Decrements an object's count of its strong external connections + Decrements an object's count of its strong external connections (references). @@ -21442,13 +21446,13 @@ Args: Returns: - typing.Any:TRUE specifies that if the connection being released is the last external lock on + typing.Any:TRUE specifies that if the connection being released is the last external lock on -the object, the object should close. FALSE specifies that the object should remain open until closed by the user +the object, the object should close. FALSE specifies that the object should remain open until closed by the user or another process.Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - + """ pass @@ -21472,13 +21476,13 @@ Args: Returns: - None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or + None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or -(None,None) if the underlying function returns S_FALSE, indicating +(None,None) if the underlying function returns S_FALSE, indicating the calling application should extract it. - + """ pass @@ -21495,7 +21499,7 @@ Args: Returns: None - + """ pass @@ -21519,13 +21523,13 @@ Args: Returns: - None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or + None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or -(None,None) if the underlying function returns S_FALSE, indicating +(None,None) if the underlying function returns S_FALSE, indicating the calling application should extract it. - + """ pass @@ -21542,7 +21546,7 @@ Args: Returns: None - + """ pass @@ -21568,7 +21572,7 @@ Args: Returns: None - + """ pass @@ -21584,7 +21588,7 @@ Args: Returns: None - + """ pass @@ -21608,7 +21612,7 @@ Returns: typing.Any:Interface that receives progress updatesReturn ValueReturns a cookie to be passed to PyIFileOperation::Unadvise to disconnect - + """ pass @@ -21624,7 +21628,7 @@ Args: Returns: None - + """ pass @@ -21640,7 +21644,7 @@ Args: Returns: None - + """ pass @@ -21656,7 +21660,7 @@ Args: Returns: None - + """ pass @@ -21672,7 +21676,7 @@ Args: Returns: None - + """ pass @@ -21688,7 +21692,7 @@ Args: Returns: None - + """ pass @@ -21704,7 +21708,7 @@ Args: Returns: None - + """ pass @@ -21720,7 +21724,7 @@ Args: Returns: None - + """ pass @@ -21736,7 +21740,7 @@ Args: Returns: None - + """ pass @@ -21754,7 +21758,7 @@ Args: Returns: None - + """ pass @@ -21771,7 +21775,7 @@ Args: Returns: None - + """ pass @@ -21790,7 +21794,7 @@ Args: Returns: None - + """ pass @@ -21807,7 +21811,7 @@ Args: Returns: None - + """ pass @@ -21826,7 +21830,7 @@ Args: Returns: None - + """ pass @@ -21843,7 +21847,7 @@ Args: Returns: None - + """ pass @@ -21860,7 +21864,7 @@ Args: Returns: None - + """ pass @@ -21876,7 +21880,7 @@ Args: Returns: None - + """ pass @@ -21896,7 +21900,7 @@ Args: Returns: None - + """ pass @@ -21912,7 +21916,7 @@ Args: Returns: None - + """ pass @@ -21928,7 +21932,7 @@ Args: Returns: typing.Any - + """ pass @@ -21959,7 +21963,7 @@ Args: Returns: None - + """ pass @@ -21983,7 +21987,7 @@ Args: Returns: None - + """ pass @@ -22006,7 +22010,7 @@ Args: Returns: None - + """ pass @@ -22022,7 +22026,7 @@ Args: Returns: None - + """ pass @@ -22038,7 +22042,7 @@ Args: Returns: None - + """ pass @@ -22061,7 +22065,7 @@ Args: Returns: None - + """ pass @@ -22077,7 +22081,7 @@ Args: Returns: None - + """ pass @@ -22100,7 +22104,7 @@ Args: Returns: None - + """ pass @@ -22116,7 +22120,7 @@ Args: Returns: None - + """ pass @@ -22139,7 +22143,7 @@ Args: Returns: None - + """ pass @@ -22156,7 +22160,7 @@ Args: Returns: None - + """ pass @@ -22172,7 +22176,7 @@ Args: Returns: None - + """ pass @@ -22188,7 +22192,7 @@ Args: Returns: None - + """ pass @@ -22215,7 +22219,7 @@ Args: Returns: None - + """ pass @@ -22235,7 +22239,7 @@ Args: Returns: None - + """ pass @@ -22253,7 +22257,7 @@ Args: Returns: None - + """ pass @@ -22273,7 +22277,7 @@ Args: Returns: typing.Any - + """ pass @@ -22300,7 +22304,7 @@ Args: Returns: None - + """ pass @@ -22316,7 +22320,7 @@ Args: Returns: None - + """ pass @@ -22333,7 +22337,7 @@ Args: Returns: None - + """ pass @@ -22349,7 +22353,7 @@ Args: Returns: None - + """ pass @@ -22365,7 +22369,7 @@ Args: Returns: None - + """ pass @@ -22381,7 +22385,7 @@ Args: Returns: None - + """ pass @@ -22404,7 +22408,7 @@ Args: Returns: None - + """ pass @@ -22421,7 +22425,7 @@ Args: Returns: None - + """ pass @@ -22439,7 +22443,7 @@ Args: Returns: None - + """ pass @@ -22457,7 +22461,7 @@ Args: Returns: None - + """ pass @@ -22480,7 +22484,7 @@ Args: Returns: None - + """ pass @@ -22496,7 +22500,7 @@ Args: Returns: None - + """ pass @@ -22513,7 +22517,7 @@ Args: Returns: None - + """ pass @@ -22530,7 +22534,7 @@ Args: Returns: None - + """ pass @@ -22549,7 +22553,7 @@ Args: Returns: None - + """ pass @@ -22567,7 +22571,7 @@ Args: Returns: None - + """ pass @@ -22584,15 +22588,15 @@ Args: Returns: None - + """ pass class PyIKnownFolder(object): - """Interface representing a known folder that serves + """Interface representing a known folder that serves -as a replacement for the numeric CSIDL definitions and API functions. +as a replacement for the numeric CSIDL definitions and API functions. Requires Vista or later.""" @@ -22611,7 +22615,7 @@ Args: Returns: PyIID - + """ pass @@ -22627,7 +22631,7 @@ Args: Returns: typing.Any - + """ pass @@ -22644,7 +22648,7 @@ Args: Returns: PyIShellItem - + """ pass @@ -22660,7 +22664,7 @@ Args: Returns: typing.Any - + """ pass @@ -22677,7 +22681,7 @@ Args: Returns: None - + """ pass @@ -22693,7 +22697,7 @@ Args: Returns: PyIDL - + """ pass @@ -22712,7 +22716,7 @@ Returns: PyIID = GetFolderType()Returns the type of the folder Return ValueReturns a folder type guid (shell.FOLDERTYPEID_*) - + """ pass @@ -22732,7 +22736,7 @@ Returns: int = GetRedirectionCapabilities()Returns flags indicating how the folder can be redirected Return ValueCombination of shellcon.KF_REDIRECTION_CAPABILITIES_* flags - + """ pass @@ -22752,7 +22756,7 @@ Returns: dict = GetFolderDefinition()Retrieves detailed information about a known folder Return ValueReturns a dict containing info from a KNOWNFOLDER_DEFINITION struct - + """ pass @@ -22775,7 +22779,7 @@ Args: Returns: PyIID - + """ pass @@ -22791,7 +22795,7 @@ Args: Returns: typing.Any - + """ pass @@ -22807,7 +22811,7 @@ Args: Returns: typing.Tuple[PyIID, ...] - + """ pass @@ -22823,7 +22827,7 @@ Args: Returns: PyIKnownFolder - + """ pass @@ -22839,7 +22843,7 @@ Args: Returns: PyIKnownFolder - + """ pass @@ -22856,7 +22860,7 @@ Args: Returns: None - + """ pass @@ -22872,7 +22876,7 @@ Args: Returns: None - + """ pass @@ -22889,14 +22893,14 @@ Args: Returns: PyIKnownFolder - + """ pass def FindFolderFromIDList(self,pidl:'PyIDL') -> 'PyIKnownFolder': """ - Retrieves a known folder using its item id + Retrieves a known folder using its item id list. @@ -22907,7 +22911,7 @@ Args: Returns: PyIKnownFolder - + """ pass @@ -22927,7 +22931,7 @@ Args: Returns: None - + """ pass @@ -22941,7 +22945,7 @@ class PyILockBytes(object): def ReadAt(self,ulOffset:'ULARGE_INTEGER',cb:'typing.Any') -> 'str': """ - Reads a specified number of bytes starting at a specified offset from the + Reads a specified number of bytes starting at a specified offset from the beginning of the byte array object. @@ -22953,14 +22957,14 @@ Args: Returns: str - + """ pass def WriteAt(self,ulOffset:'ULARGE_INTEGER',data:'str') -> 'typing.Any': """ - Writes the specified number of bytes starting at a specified offset from the + Writes the specified number of bytes starting at a specified offset from the beginning of the byte array. @@ -22973,14 +22977,14 @@ Returns: typing.Any:Data to writeReturn ValueThe result is the number of bytes actually written. - + """ pass def Flush(self,) -> 'None': """ - Ensures that any internal buffers maintained by the byte array object are written out + Ensures that any internal buffers maintained by the byte array object are written out to the backing storage. @@ -22991,7 +22995,7 @@ Args: Returns: None - + """ pass @@ -23007,7 +23011,7 @@ Args: Returns: None - + """ pass @@ -23025,7 +23029,7 @@ Args: Returns: None - + """ pass @@ -23043,7 +23047,7 @@ Args: Returns: None - + """ pass @@ -23059,7 +23063,7 @@ Args: Returns: STATSTG - + """ pass @@ -23084,7 +23088,7 @@ Args: Returns: typing.Any - + """ pass @@ -23100,7 +23104,7 @@ Args: Returns: PyIMAPITable - + """ pass @@ -23116,7 +23120,7 @@ Args: Returns: PyIMAPITable - + """ pass @@ -23140,7 +23144,7 @@ Args: Returns: typing.Any - + """ pass @@ -23160,7 +23164,7 @@ Args: Returns: PyIMAPIFolder - + """ pass @@ -23177,7 +23181,7 @@ Args: Returns: PyIMessage - + """ pass @@ -23198,7 +23202,7 @@ Args: Returns: typing.Any - + """ pass @@ -23216,7 +23220,7 @@ Args: Returns: None - + """ pass @@ -23235,7 +23239,7 @@ Args: Returns: typing.Any - + """ pass @@ -23253,7 +23257,7 @@ Args: Returns: typing.Any - + """ pass @@ -23272,7 +23276,7 @@ Args: Returns: None - + """ pass @@ -23296,7 +23300,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any] - + """ pass @@ -23313,7 +23317,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any] - + """ pass @@ -23330,7 +23334,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any] - + """ pass @@ -23353,7 +23357,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any] - + """ pass @@ -23375,7 +23379,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any] - + """ pass @@ -23394,7 +23398,7 @@ Args: Returns: PyIUnknown - + """ pass @@ -23411,7 +23415,7 @@ Args: Returns: PySPropTagArray - + """ pass @@ -23429,7 +23433,7 @@ Args: Returns: typing.Tuple[typing.Any, PySPropTagArray, PyMAPINAMEIDArray] - + """ pass @@ -23446,7 +23450,7 @@ Args: Returns: typing.Any - + """ pass @@ -23462,7 +23466,7 @@ Args: Returns: None - + """ pass @@ -23478,7 +23482,7 @@ Args: Returns: PySPropTagArray - + """ pass @@ -23503,7 +23507,7 @@ Args: Returns: typing.Any - + """ pass @@ -23522,7 +23526,7 @@ Args: Returns: PyIUnknown - + """ pass @@ -23538,7 +23542,7 @@ Args: Returns: str - + """ pass @@ -23555,11 +23559,11 @@ Args: Returns: - typing.Any:Return ValueThe result is an integer which should be passed to + typing.Any:Return ValueThe result is an integer which should be passed to PyIMAPISession::Unadvise - + """ pass @@ -23575,7 +23579,7 @@ Args: Returns: None - + """ pass @@ -23595,7 +23599,7 @@ Returns: typing.Any:Reserved - must be zero. Return ValueThe result is set to TRUE if the two entry identifiers refer to the same object, and FALSE otherwise. - + """ pass @@ -23612,7 +23616,7 @@ Args: Returns: typing.Any - + """ pass @@ -23628,7 +23632,7 @@ Args: Returns: PyIMAPITable - + """ pass @@ -23644,7 +23648,7 @@ Args: Returns: PyIMAPITable - + """ pass @@ -23662,7 +23666,7 @@ Args: Returns: None - + """ pass @@ -23680,7 +23684,7 @@ Args: Returns: PyIAddrBook - + """ pass @@ -23698,7 +23702,7 @@ Args: Returns: typing.Any - + """ pass @@ -23714,7 +23718,7 @@ Args: Returns: PyIMsgServiceAdmin - + """ pass @@ -23739,7 +23743,7 @@ Args: Returns: None - + """ pass @@ -23756,7 +23760,7 @@ Args: Returns: None - + """ pass @@ -23773,7 +23777,7 @@ Args: Returns: None - + """ pass @@ -23791,7 +23795,7 @@ Args: Returns: None - + """ pass @@ -23815,7 +23819,7 @@ Args: Returns: typing.Any - + """ pass @@ -23832,7 +23836,7 @@ Args: Returns: typing.Any - + """ pass @@ -23850,7 +23854,7 @@ Returns: typing.Any:Return ValueThe result is the number of rows processed. - + """ pass @@ -23867,7 +23871,7 @@ Args: Returns: None - + """ pass @@ -23883,7 +23887,7 @@ Args: Returns: typing.Any - + """ pass @@ -23900,7 +23904,7 @@ Args: Returns: typing.Any - + """ pass @@ -23917,7 +23921,7 @@ Args: Returns: None - + """ pass @@ -23936,7 +23940,7 @@ Returns: GetStatus()Returns the table's status and type. Return ValueResult is a tuple of (tableStatus, tableType) - + """ pass @@ -23955,7 +23959,7 @@ Returns: QueryPosition()Retrieves the current table row position of the cursor, based on a fractional value. Return ValueResult is a tuple of (row, numerator, denominator) - + """ pass @@ -23971,7 +23975,7 @@ Args: Returns: typing.Any - + """ pass @@ -23987,7 +23991,7 @@ Args: Returns: None - + """ pass @@ -24003,7 +24007,7 @@ Args: Returns: None - + """ pass @@ -24019,7 +24023,7 @@ Args: Returns: typing.Any - + """ pass @@ -24036,7 +24040,7 @@ Args: Returns: None - + """ pass @@ -24054,7 +24058,7 @@ Args: Returns: None - + """ pass @@ -24071,7 +24075,7 @@ Args: Returns: None - + """ pass @@ -24087,7 +24091,7 @@ Args: Returns: None - + """ pass @@ -24110,7 +24114,7 @@ Args: Returns: None - + """ pass @@ -24126,7 +24130,7 @@ Args: Returns: None - + """ pass @@ -24142,7 +24146,7 @@ Args: Returns: None - + """ pass @@ -24166,7 +24170,7 @@ Args: Returns: None - + """ pass @@ -24183,7 +24187,7 @@ Args: Returns: None - + """ pass @@ -24206,7 +24210,7 @@ Args: Returns: None - + """ pass @@ -24222,7 +24226,7 @@ Args: Returns: PyIMAPITable - + """ pass @@ -24240,7 +24244,7 @@ Args: Returns: PyIAttach - + """ pass @@ -24258,7 +24262,7 @@ Returns: typing.Tuple[typing.Any, PyIAttach]:Bitmask of flags that controls how the attachment is created.Return ValueThe result is a tuple of (attachmentNum, attachmentObject) - + """ pass @@ -24277,7 +24281,7 @@ Args: Returns: None - + """ pass @@ -24294,7 +24298,7 @@ Args: Returns: None - + """ pass @@ -24310,7 +24314,7 @@ Args: Returns: PyIMAPITable - + """ pass @@ -24326,7 +24330,7 @@ Args: Returns: None - + """ pass @@ -24351,14 +24355,14 @@ Args: Returns: PyIUnknown - + """ pass def BindToStorage(self,bindCtx:'PyIBindCtx',moniker:'PyIMoniker',iidResult:'typing.Any') -> 'PyIUnknown': """ - Retrieves an interface object to the storage that contains the + Retrieves an interface object to the storage that contains the object identified by the moniker. @@ -24371,14 +24375,14 @@ Args: Returns: PyIUnknown - + """ pass def GetDisplayName(self,bindCtx:'PyIBindCtx',moniker:'PyIMoniker') -> 'str': """ - Gets the display name , which is a user-readable representation of this + Gets the display name , which is a user-readable representation of this moniker. @@ -24390,14 +24394,14 @@ Args: Returns: str - + """ pass def ComposeWith(self,mkRight:'PyIMoniker',fOnlyIfNotGeneric:'typing.Any') -> 'PyIMoniker': """ - Combines the current moniker with another moniker, creating a new + Combines the current moniker with another moniker, creating a new composite moniker. @@ -24409,14 +24413,14 @@ Args: Returns: PyIMoniker - + """ pass def Enum(self,fForward:'typing.Any'=True) -> 'PyIEnumMoniker': """ - Supplies an enumerator that can enumerate the components of a composite + Supplies an enumerator that can enumerate the components of a composite moniker. @@ -24427,14 +24431,14 @@ Args: Returns: PyIEnumMoniker - + """ pass def IsEqual(self,other:'PyIMoniker') -> 'typing.Any': """ - Compares this moniker with a specified moniker and indicates whether they are + Compares this moniker with a specified moniker and indicates whether they are identical. @@ -24445,14 +24449,14 @@ Args: Returns: typing.Any - + """ pass def IsSystemMoniker(self,) -> 'typing.Any': """ - Indicates whether this moniker is of one of the system-supplied moniker + Indicates whether this moniker is of one of the system-supplied moniker classes. @@ -24463,7 +24467,7 @@ Args: Returns: typing.Any - + """ pass @@ -24479,7 +24483,7 @@ Args: Returns: typing.Any - + """ pass @@ -24503,7 +24507,7 @@ Args: Returns: typing.Any - + """ pass @@ -24522,7 +24526,7 @@ Args: Returns: None - + """ pass @@ -24541,7 +24545,7 @@ Args: Returns: None - + """ pass @@ -24557,7 +24561,7 @@ Args: Returns: PyIMAPITable - + """ pass @@ -24573,7 +24577,7 @@ Args: Returns: PyIMAPITable - + """ pass @@ -24589,7 +24593,7 @@ Args: Returns: None - + """ pass @@ -24607,7 +24611,7 @@ Args: Returns: None - + """ pass @@ -24625,14 +24629,14 @@ Args: Returns: typing.Any - + """ pass def AdminProviders(self,uuid:'PyIID',flags:'typing.Any') -> 'typing.Any': """ - Returns an object providing access + Returns an object providing access to a provider administration object. @@ -24644,7 +24648,7 @@ Args: Returns: typing.Any - + """ pass @@ -24669,7 +24673,7 @@ Args: Returns: typing.Any - + """ pass @@ -24686,7 +24690,7 @@ Args: Returns: typing.Tuple[PyIID, str] - + """ pass @@ -24702,7 +24706,7 @@ Args: Returns: PyIMAPITable - + """ pass @@ -24722,7 +24726,7 @@ Returns: typing.Any:Reserved - must be zero. Return ValueThe result is set to TRUE if the two entry identifiers refer to the same object, and FALSE otherwise. - + """ pass @@ -24739,7 +24743,7 @@ Args: Returns: typing.Any - + """ pass @@ -24756,7 +24760,7 @@ Args: Returns: typing.Any - + """ pass @@ -24774,7 +24778,7 @@ Args: Returns: None - + """ pass @@ -24790,7 +24794,7 @@ Args: Returns: None - + """ pass @@ -24815,7 +24819,7 @@ Args: Returns: None - + """ pass @@ -24831,7 +24835,7 @@ Args: Returns: None - + """ pass @@ -24847,7 +24851,7 @@ Args: Returns: None - + """ pass @@ -24866,7 +24870,7 @@ Args: Returns: None - + """ pass @@ -24886,7 +24890,7 @@ Args: Returns: None - + """ pass @@ -24902,7 +24906,7 @@ Args: Returns: None - + """ pass @@ -24918,7 +24922,7 @@ Args: Returns: None - + """ pass @@ -24934,7 +24938,7 @@ Args: Returns: None - + """ pass @@ -24952,7 +24956,7 @@ Args: Returns: None - + """ pass @@ -24969,7 +24973,7 @@ Args: Returns: None - + """ pass @@ -24985,7 +24989,7 @@ Args: Returns: None - + """ pass @@ -25001,7 +25005,7 @@ Args: Returns: None - + """ pass @@ -25018,7 +25022,7 @@ Args: Returns: None - + """ pass @@ -25034,7 +25038,7 @@ Args: Returns: None - + """ pass @@ -25050,7 +25054,7 @@ Args: Returns: None - + """ pass @@ -25067,7 +25071,7 @@ Args: Returns: None - + """ pass @@ -25083,7 +25087,7 @@ Args: Returns: None - + """ pass @@ -25099,7 +25103,7 @@ Args: Returns: None - + """ pass @@ -25115,7 +25119,7 @@ Args: Returns: None - + """ pass @@ -25138,7 +25142,7 @@ Args: Returns: PyPROPVARIANT - + """ pass @@ -25154,7 +25158,7 @@ Args: Returns: None - + """ pass @@ -25170,7 +25174,7 @@ Args: Returns: typing.Any - + """ pass @@ -25186,7 +25190,7 @@ Args: Returns: typing.Any - + """ pass @@ -25209,7 +25213,7 @@ Args: Returns: typing.Any - + """ pass @@ -25226,7 +25230,7 @@ Args: Returns: PyIUnknown - + """ pass @@ -25249,7 +25253,7 @@ Args: Returns: None - + """ pass @@ -25265,7 +25269,7 @@ Args: Returns: None - + """ pass @@ -25281,7 +25285,7 @@ Args: Returns: None - + """ pass @@ -25297,7 +25301,7 @@ Args: Returns: None - + """ pass @@ -25320,7 +25324,7 @@ Args: Returns: None - + """ pass @@ -25336,7 +25340,7 @@ Args: Returns: PyPROPERTYKEY - + """ pass @@ -25359,7 +25363,7 @@ Args: Returns: None - + """ pass @@ -25375,7 +25379,7 @@ Args: Returns: None - + """ pass @@ -25398,7 +25402,7 @@ Args: Returns: None - + """ pass @@ -25415,7 +25419,7 @@ Args: Returns: None - + """ pass @@ -25431,7 +25435,7 @@ Args: Returns: None - + """ pass @@ -25447,7 +25451,7 @@ Args: Returns: None - + """ pass @@ -25463,7 +25467,7 @@ Args: Returns: None - + """ pass @@ -25479,7 +25483,7 @@ Args: Returns: None - + """ pass @@ -25502,7 +25506,7 @@ Args: Returns: None - + """ pass @@ -25518,7 +25522,7 @@ Args: Returns: None - + """ pass @@ -25541,7 +25545,7 @@ Args: Returns: None - + """ pass @@ -25557,7 +25561,7 @@ Args: Returns: None - + """ pass @@ -25573,7 +25577,7 @@ Args: Returns: None - + """ pass @@ -25589,7 +25593,7 @@ Args: Returns: None - + """ pass @@ -25612,7 +25616,7 @@ Args: Returns: None - + """ pass @@ -25628,7 +25632,7 @@ Args: Returns: None - + """ pass @@ -25644,7 +25648,7 @@ Args: Returns: None - + """ pass @@ -25661,11 +25665,11 @@ Args: Returns: - None:Description for dwFlagsReturn ValueThe result is a tuple of the transformed input points - ie, + None:Description for dwFlagsReturn ValueThe result is a tuple of the transformed input points - ie, a tuple of ((int, int), (float, float)) - + """ pass @@ -25682,7 +25686,7 @@ Args: Returns: None - + """ pass @@ -25698,7 +25702,7 @@ Args: Returns: None - + """ pass @@ -25714,7 +25718,7 @@ Args: Returns: None - + """ pass @@ -25737,7 +25741,7 @@ Args: Returns: None - + """ pass @@ -25753,7 +25757,7 @@ Args: Returns: None - + """ pass @@ -25769,7 +25773,7 @@ Args: Returns: None - + """ pass @@ -25787,7 +25791,7 @@ Args: Returns: None - + """ pass @@ -25803,7 +25807,7 @@ Args: Returns: None - + """ pass @@ -25827,7 +25831,7 @@ Args: Returns: None - + """ pass @@ -25845,7 +25849,7 @@ Args: Returns: None - + """ pass @@ -25861,7 +25865,7 @@ Args: Returns: None - + """ pass @@ -25877,7 +25881,7 @@ Args: Returns: None - + """ pass @@ -25893,7 +25897,7 @@ Args: Returns: None - + """ pass @@ -25910,7 +25914,7 @@ Args: Returns: None - + """ pass @@ -25933,7 +25937,7 @@ Args: Returns: None - + """ pass @@ -25949,7 +25953,7 @@ Args: Returns: None - + """ pass @@ -25965,7 +25969,7 @@ Args: Returns: None - + """ pass @@ -25981,7 +25985,7 @@ Args: Returns: None - + """ pass @@ -26004,7 +26008,7 @@ Args: Returns: None - + """ pass @@ -26020,7 +26024,7 @@ Args: Returns: None - + """ pass @@ -26036,7 +26040,7 @@ Args: Returns: None - + """ pass @@ -26052,7 +26056,7 @@ Args: Returns: None - + """ pass @@ -26068,7 +26072,7 @@ Args: Returns: None - + """ pass @@ -26084,7 +26088,7 @@ Args: Returns: None - + """ pass @@ -26100,7 +26104,7 @@ Args: Returns: None - + """ pass @@ -26116,7 +26120,7 @@ Args: Returns: None - + """ pass @@ -26132,7 +26136,7 @@ Args: Returns: None - + """ pass @@ -26148,7 +26152,7 @@ Args: Returns: None - + """ pass @@ -26171,7 +26175,7 @@ Args: Returns: None - + """ pass @@ -26187,7 +26191,7 @@ Args: Returns: None - + """ pass @@ -26203,7 +26207,7 @@ Args: Returns: None - + """ pass @@ -26226,7 +26230,7 @@ Args: Returns: None - + """ pass @@ -26242,7 +26246,7 @@ Args: Returns: None - + """ pass @@ -26258,7 +26262,7 @@ Args: Returns: None - + """ pass @@ -26274,7 +26278,7 @@ Args: Returns: None - + """ pass @@ -26290,7 +26294,7 @@ Args: Returns: None - + """ pass @@ -26307,7 +26311,7 @@ Args: Returns: None - + """ pass @@ -26323,7 +26327,7 @@ Args: Returns: None - + """ pass @@ -26340,7 +26344,7 @@ Args: Returns: None - + """ pass @@ -26357,7 +26361,7 @@ Args: Returns: None - + """ pass @@ -26374,7 +26378,7 @@ Args: Returns: None - + """ pass @@ -26390,7 +26394,7 @@ Args: Returns: None - + """ pass @@ -26408,7 +26412,7 @@ Args: Returns: None - + """ pass @@ -26431,7 +26435,7 @@ Args: Returns: None - + """ pass @@ -26447,7 +26451,7 @@ Args: Returns: None - + """ pass @@ -26463,7 +26467,7 @@ Args: Returns: None - + """ pass @@ -26480,7 +26484,7 @@ Args: Returns: None - + """ pass @@ -26503,7 +26507,7 @@ Args: Returns: None - + """ pass @@ -26519,7 +26523,7 @@ Args: Returns: None - + """ pass @@ -26536,7 +26540,7 @@ Args: Returns: None - + """ pass @@ -26552,7 +26556,7 @@ Args: Returns: None - + """ pass @@ -26569,7 +26573,7 @@ Args: Returns: None - + """ pass @@ -26586,7 +26590,7 @@ Args: Returns: None - + """ pass @@ -26604,7 +26608,7 @@ Args: Returns: None - + """ pass @@ -26620,7 +26624,7 @@ Args: Returns: None - + """ pass @@ -26641,7 +26645,7 @@ Args: Returns: None - + """ pass @@ -26657,7 +26661,7 @@ Args: Returns: None - + """ pass @@ -26673,7 +26677,7 @@ Args: Returns: None - + """ pass @@ -26689,7 +26693,7 @@ Args: Returns: None - + """ pass @@ -26705,7 +26709,7 @@ Args: Returns: None - + """ pass @@ -26721,7 +26725,7 @@ Args: Returns: None - + """ pass @@ -26738,7 +26742,7 @@ Args: Returns: None - + """ pass @@ -26755,7 +26759,7 @@ Args: Returns: None - + """ pass @@ -26771,7 +26775,7 @@ Args: Returns: None - + """ pass @@ -26787,7 +26791,7 @@ Args: Returns: None - + """ pass @@ -26803,7 +26807,7 @@ Args: Returns: None - + """ pass @@ -26819,7 +26823,7 @@ Args: Returns: None - + """ pass @@ -26835,7 +26839,7 @@ Args: Returns: None - + """ pass @@ -26858,7 +26862,7 @@ Args: Returns: None - + """ pass @@ -26874,7 +26878,7 @@ Args: Returns: None - + """ pass @@ -26897,7 +26901,7 @@ Args: Returns: PyIID - + """ pass @@ -26921,13 +26925,13 @@ Returns: None:PyIPersistFile.IsDirty IsDirty()Checks an object for changes since it was last saved to its current file. -Return ValueThis method returns the raw COM error code without raising the normal COM exception. +Return ValueThis method returns the raw COM error code without raising the normal COM exception. -You should treat any error return codes as an indication that the object has changed. +You should treat any error return codes as an indication that the object has changed. Unless this method explicitly returns S_FALSE, assume that the object must be saved. - + """ pass @@ -26944,7 +26948,7 @@ Args: Returns: None - + """ pass @@ -26961,7 +26965,7 @@ Args: Returns: None - + """ pass @@ -26977,7 +26981,7 @@ Args: Returns: None - + """ pass @@ -26993,7 +26997,7 @@ Args: Returns: typing.Any - + """ pass @@ -27016,7 +27020,7 @@ Args: Returns: None - + """ pass @@ -27039,7 +27043,7 @@ Args: Returns: None - + """ pass @@ -27053,7 +27057,7 @@ class PyIPersistPropertyBag(object): def InitNew(self,) -> 'None': """ - Called by the container when the control is initialized to initialize the + Called by the container when the control is initialized to initialize the property bag. @@ -27064,7 +27068,7 @@ Args: Returns: None - + """ pass @@ -27081,7 +27085,7 @@ Args: Returns: None - + """ pass @@ -27099,7 +27103,7 @@ Args: Returns: None - + """ pass @@ -27122,7 +27126,7 @@ Args: Returns: None - + """ pass @@ -27138,14 +27142,14 @@ Args: Returns: None - + """ pass def GetPropertyStorage(self,) -> 'typing.Any': """ - Retrieves the current contents of the property + Retrieves the current contents of the property store @@ -27156,7 +27160,7 @@ Args: Returns: typing.Any - + """ pass @@ -27179,7 +27183,7 @@ Args: Returns: typing.Any - + """ pass @@ -27195,7 +27199,7 @@ Args: Returns: None - + """ pass @@ -27211,7 +27215,7 @@ Args: Returns: None - + """ pass @@ -27228,7 +27232,7 @@ Args: Returns: None - + """ pass @@ -27244,16 +27248,16 @@ Args: Returns: None - + """ pass def HandsOffStorage(self,) -> 'None': """ - Instructs the object to release all storage objects that have been + Instructs the object to release all storage objects that have been -passed to it by its container and to enter HandsOff mode, in which the object cannot do anything and the only +passed to it by its container and to enter HandsOff mode, in which the object cannot do anything and the only operation that works is a close operation. @@ -27264,7 +27268,7 @@ Args: Returns: None - + """ pass @@ -27287,7 +27291,7 @@ Args: Returns: typing.Any - + """ pass @@ -27303,7 +27307,7 @@ Args: Returns: None - + """ pass @@ -27320,14 +27324,14 @@ Args: Returns: None - + """ pass def GetSizeMax(self,) -> 'ULARGE_INTEGER': """ - Returns the size in bytes of the stream needed to save the + Returns the size in bytes of the stream needed to save the object. @@ -27338,7 +27342,7 @@ Args: Returns: ULARGE_INTEGER - + """ pass @@ -27361,7 +27365,7 @@ Args: Returns: None - + """ pass @@ -27384,7 +27388,7 @@ Args: Returns: None - + """ pass @@ -27400,7 +27404,7 @@ Args: Returns: None - + """ pass @@ -27416,7 +27420,7 @@ Args: Returns: None - + """ pass @@ -27432,7 +27436,7 @@ Args: Returns: None - + """ pass @@ -27448,7 +27452,7 @@ Args: Returns: None - + """ pass @@ -27472,7 +27476,7 @@ Args: Returns: typing.Any - + """ pass @@ -27491,7 +27495,7 @@ Args: Returns: None - + """ pass @@ -27508,7 +27512,7 @@ Args: Returns: None - + """ pass @@ -27528,7 +27532,7 @@ Args: Returns: None - + """ pass @@ -27548,7 +27552,7 @@ Args: Returns: None - + """ pass @@ -27565,7 +27569,7 @@ Args: Returns: None - + """ pass @@ -27584,7 +27588,7 @@ Args: Returns: PyIProfAdmin - + """ pass @@ -27598,7 +27602,7 @@ class PyIPropertyBag(object): def Read(self,propName:'typing.Any',propType:'typing.Any',errorLog:'PyIErrorLog'=None) -> 'typing.Any': """ - Called by the control to read a property from the storage provided by the + Called by the control to read a property from the storage provided by the container. @@ -27611,14 +27615,14 @@ Args: Returns: typing.Any - + """ pass def Write(self,propName:'typing.Any',value:'typing.Any') -> 'None': """ - Called by the control to write each property in turn to the storage provided by the + Called by the control to write each property in turn to the storage provided by the container. @@ -27630,7 +27634,7 @@ Args: Returns: None - + """ pass @@ -27653,7 +27657,7 @@ Args: Returns: PyPROPVARIANT - + """ pass @@ -27676,7 +27680,7 @@ Args: Returns: typing.Any - + """ pass @@ -27693,7 +27697,7 @@ Args: Returns: PyIPropertyChange - + """ pass @@ -27710,7 +27714,7 @@ Args: Returns: None - + """ pass @@ -27726,14 +27730,14 @@ Args: Returns: None - + """ pass def AppendOrReplace(self,PropChange:'PyIPropertyChange') -> 'None': """ - Adds a change, or replaces if an identical property key is already + Adds a change, or replaces if an identical property key is already in container @@ -27744,7 +27748,7 @@ Args: Returns: None - + """ pass @@ -27760,7 +27764,7 @@ Args: Returns: None - + """ pass @@ -27776,7 +27780,7 @@ Args: Returns: typing.Any - + """ pass @@ -27799,7 +27803,7 @@ Args: Returns: PyPROPERTYKEY - + """ pass @@ -27815,7 +27819,7 @@ Args: Returns: typing.Any - + """ pass @@ -27831,7 +27835,7 @@ Args: Returns: typing.Any - + """ pass @@ -27847,7 +27851,7 @@ Args: Returns: typing.Any - + """ pass @@ -27863,7 +27867,7 @@ Args: Returns: typing.Any - + """ pass @@ -27879,14 +27883,14 @@ Args: Returns: typing.Any - + """ pass def GetViewFlags(self,) -> 'typing.Any': """ - Returns the view flags that control how the property is displayed + Returns the view flags that control how the property is displayed (PDVF_*) @@ -27897,7 +27901,7 @@ Args: Returns: typing.Any - + """ pass @@ -27913,7 +27917,7 @@ Args: Returns: typing.Any - + """ pass @@ -27929,14 +27933,14 @@ Args: Returns: typing.Any - + """ pass def GetColumnState(self,) -> 'typing.Any': """ - Returns flags that control how property is displayed in column + Returns flags that control how property is displayed in column (SHCOLSTATE_*) @@ -27947,7 +27951,7 @@ Args: Returns: typing.Any - + """ pass @@ -27963,7 +27967,7 @@ Args: Returns: typing.Any - + """ pass @@ -27979,7 +27983,7 @@ Args: Returns: typing.Any - + """ pass @@ -27996,14 +28000,14 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass def GetSortDescription(self,) -> 'typing.Any': """ - Returns value that determines how sorting options are + Returns value that determines how sorting options are displayed (PDSD_*) @@ -28014,7 +28018,7 @@ Args: Returns: typing.Any - + """ pass @@ -28030,14 +28034,14 @@ Args: Returns: typing.Any - + """ pass def GetAggregationType(self,) -> 'typing.Any': """ - Describes how properties for multiple items are displayed + Describes how properties for multiple items are displayed (PDAT_*) @@ -28048,14 +28052,14 @@ Args: Returns: typing.Any - + """ pass def GetConditionType(self,) -> 'typing.Tuple[typing.Any, typing.Any]': """ - Returns options that determine how the property is used + Returns options that determine how the property is used to build a search query @@ -28067,19 +28071,19 @@ Returns: typing.Tuple[typing.Any, typing.Any]:PyIPropertyDescription.GetConditionType -(int, int) = GetConditionType()Returns options that determine how the property is used +(int, int) = GetConditionType()Returns options that determine how the property is used to build a search query Return ValueReturns the condition type (PDCOT_*) and default operation (COP_*) - + """ pass def GetEnumTypeList(self,riid:'PyIID') -> 'PyIPropertyEnumTypeList': """ - Returns an interface used for querying + Returns an interface used for querying valid property range @@ -28090,14 +28094,14 @@ Args: Returns: PyIPropertyEnumTypeList - + """ pass def CoerceToCanonicalValue(self,Value:'PyPROPVARIANT') -> 'typing.Any': """ - Converts a variant value to the exact type expected by + Converts a variant value to the exact type expected by the property @@ -28112,7 +28116,7 @@ Returns: This method mutates the PyPROPVARIANT in place. It may be cleared on failure. Return ValueReturns the HRESULT from the operation on success. - + """ pass @@ -28129,14 +28133,14 @@ Args: Returns: typing.Any - + """ pass def IsValueCanonical(self,Value:'typing.Any') -> 'typing.Any': """ - Determines if a value exactly matches the specification for + Determines if a value exactly matches the specification for the property @@ -28147,7 +28151,7 @@ Args: Returns: typing.Any - + """ pass @@ -28161,7 +28165,7 @@ class PyIPropertyDescriptionAliasInfo(object): def GetSortByAlias(self,riid:'PyIID') -> 'PyIPropertyDescription': """ - Returns the primary column used + Returns the primary column used for sorting @@ -28172,14 +28176,14 @@ Args: Returns: PyIPropertyDescription - + """ pass def GetAdditionalSortByAliases(self,riid:'PyIID') -> 'PyIPropertyDescriptionList': """ - Returns secondary + Returns secondary sorting columns @@ -28190,7 +28194,7 @@ Args: Returns: PyIPropertyDescriptionList - + """ pass @@ -28213,7 +28217,7 @@ Args: Returns: typing.Any - + """ pass @@ -28230,7 +28234,7 @@ Args: Returns: PyIPropertyDescription - + """ pass @@ -28257,7 +28261,7 @@ Returns: int = GetSearchInfoFlags()Returns flags controlling how property is indexed Return ValueReturns a combination of PROPDESC_SEARCHINFO_FLAGS values - + """ pass @@ -28277,7 +28281,7 @@ Returns: int = GetColumnIndexType()Returns flags indicating type of property Return ValueReturns a value from the PROPDESC_COLUMNINDEX_TYPE enum - + """ pass @@ -28293,7 +28297,7 @@ Args: Returns: typing.Any - + """ pass @@ -28309,7 +28313,7 @@ Args: Returns: typing.Any - + """ pass @@ -28336,7 +28340,7 @@ Returns: int = GetEnumType()Retrieves the type (PROPENUMTYPE) Return Valuepscon.PET_* - + """ pass @@ -28352,7 +28356,7 @@ Args: Returns: PyPROPVARIANT - + """ pass @@ -28368,7 +28372,7 @@ Args: Returns: PyPROPVARIANT - + """ pass @@ -28384,7 +28388,7 @@ Args: Returns: PyPROPVARIANT - + """ pass @@ -28400,7 +28404,7 @@ Args: Returns: None - + """ pass @@ -28423,7 +28427,7 @@ Args: Returns: typing.Any - + """ pass @@ -28440,14 +28444,14 @@ Args: Returns: PyIPropertyEnumType - + """ pass def FindMatchingIndex(self,Cmp:'PyPROPVARIANT') -> 'typing.Any': """ - Attempts to match the specified value to one of the allowable + Attempts to match the specified value to one of the allowable values for the property @@ -28458,13 +28462,13 @@ Args: Returns: typing.Any - + """ pass class PyIPropertySetStorage(object): - """Container for a collection of property sets. + """Container for a collection of property sets. Can be iterated over to enumerate property sets.""" @@ -28486,7 +28490,7 @@ Args: Returns: PyIPropertyStorage - + """ pass @@ -28503,7 +28507,7 @@ Args: Returns: PyIPropertyStorage - + """ pass @@ -28519,14 +28523,14 @@ Args: Returns: None - + """ pass def Enum(self,) -> 'PyIEnumSTATPROPSETSTG': """ - Creates an iterator to enumerate contained property + Creates an iterator to enumerate contained property sets @@ -28537,13 +28541,13 @@ Args: Returns: PyIEnumSTATPROPSETSTG - + """ pass class PyIPropertyStorage(object): - """Structured storage object that contains a set of properties. + """Structured storage object that contains a set of properties. Supports iteration to list properties.""" @@ -28563,7 +28567,7 @@ Returns: typing.Tuple[typing.Any, ...]:Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type - + """ pass @@ -28581,7 +28585,7 @@ Args: Returns: None - + """ pass @@ -28597,14 +28601,14 @@ Args: Returns: None - + """ pass def ReadPropertyNames(self,props:'typing.Tuple[typing.Any, ...]') -> 'typing.Tuple[typing.Any, ...]': """ - Retrieves any existing string names for the specified + Retrieves any existing string names for the specified property identifiers. @@ -28615,14 +28619,14 @@ Args: Returns: typing.Tuple[typing.Any, ...] - + """ pass def WritePropertyNames(self,props:'typing.Tuple[typing.Any, ...]',names:'typing.Tuple[str, ...]') -> 'None': """ - Assigns string names to a specified array of property IDs in the + Assigns string names to a specified array of property IDs in the current property set. @@ -28634,7 +28638,7 @@ Args: Returns: None - + """ pass @@ -28650,7 +28654,7 @@ Args: Returns: None - + """ pass @@ -28666,7 +28670,7 @@ Args: Returns: None - + """ pass @@ -28682,7 +28686,7 @@ Args: Returns: None - + """ pass @@ -28698,7 +28702,7 @@ Args: Returns: PyIEnumSTATPROPSTG - + """ pass @@ -28716,7 +28720,7 @@ Args: Returns: None - + """ pass @@ -28732,7 +28736,7 @@ Args: Returns: None - + """ pass @@ -28752,7 +28756,7 @@ Returns: tuple = Stat()Returns various infomation about the property set Return ValueReturns a tuple representing a STATPROPSETSTG struct. - + """ pass @@ -28775,7 +28779,7 @@ Args: Returns: typing.Any - + """ pass @@ -28791,7 +28795,7 @@ Args: Returns: PyPROPERTYKEY - + """ pass @@ -28807,7 +28811,7 @@ Args: Returns: PyPROPVARIANT - + """ pass @@ -28824,7 +28828,7 @@ Args: Returns: None - + """ pass @@ -28840,7 +28844,7 @@ Args: Returns: None - + """ pass @@ -28864,14 +28868,14 @@ Returns: typing.Any:Property identifierReturn ValueA value from the PSC_STATE enum (PSC_NORMAL, PSC_NOTINSOURCE. PSC_DIRTY) - + """ pass def GetValueAndState(self,key:'PyPROPERTYKEY') -> 'typing.Tuple[PyPROPVARIANT, typing.Any]': """ - Retrieves the current value and state of a + Retrieves the current value and state of a property @@ -28882,7 +28886,7 @@ Args: Returns: typing.Tuple[PyPROPVARIANT, typing.Any] - + """ pass @@ -28899,7 +28903,7 @@ Args: Returns: None - + """ pass @@ -28917,13 +28921,13 @@ Args: Returns: None - + """ pass class PyIPropertyStoreCapabilities(object): - """Property providers use this interface to indicate whether properties are + """Property providers use this interface to indicate whether properties are writeable.""" @@ -28942,7 +28946,7 @@ Args: Returns: typing.Any - + """ pass @@ -28956,7 +28960,7 @@ class PyIPropertySystem(object): def GetPropertyDescription(self,Key:'PyPROPERTYKEY',riid:'PyIID') -> 'PyIPropertyDescription': """ - Returns an interface used to describe a + Returns an interface used to describe a property @@ -28968,14 +28972,14 @@ Args: Returns: PyIPropertyDescription - + """ pass def GetPropertyDescriptionByName(self,CanonicalName:'typing.Any',riid:'PyIID') -> 'PyIPropertyDescription': """ - Returns an interface used to + Returns an interface used to describe a property @@ -28987,14 +28991,14 @@ Args: Returns: PyIPropertyDescription - + """ pass def GetPropertyDescriptionListFromString(self,PropList:'typing.Any',riid:'PyIID') -> 'PyIPropertyDescriptionList': """ - Retrieves property + Retrieves property descriptions from a string of property names @@ -29006,14 +29010,14 @@ Args: Returns: PyIPropertyDescriptionList - + """ pass def EnumeratePropertyDescriptions(self,Filter:'typing.Any',riid:'PyIID') -> 'PyIPropertyDescriptionList': """ - Returns an interface used to + Returns an interface used to list defined properties @@ -29025,7 +29029,7 @@ Args: Returns: PyIPropertyDescriptionList - + """ pass @@ -29043,7 +29047,7 @@ Args: Returns: typing.Any - + """ pass @@ -29059,7 +29063,7 @@ Args: Returns: None - + """ pass @@ -29075,7 +29079,7 @@ Args: Returns: None - + """ pass @@ -29091,7 +29095,7 @@ Args: Returns: None - + """ pass @@ -29114,7 +29118,7 @@ Args: Returns: PyITypeInfo - + """ pass @@ -29137,7 +29141,7 @@ Args: Returns: PyIID - + """ pass @@ -29160,7 +29164,7 @@ Args: Returns: None - + """ pass @@ -29174,7 +29178,7 @@ class PyIProvideTaskPage(object): def GetPage(self,tpType:'typing.Any',PersistChanges:'typing.Any') -> 'None': """ - Return a property sheet page handle for the spedified type + Return a property sheet page handle for the spedified type (TASKPAGE_TASK,TASKPAGE_SCHEDULE,TASKPAGE_SETTINGS) @@ -29186,7 +29190,7 @@ Args: Returns: None - + """ pass @@ -29200,7 +29204,7 @@ class PyIQueryAssociations(object): def Init(self,flags:'typing.Any',assoc:'str',hkeyProgId:'PyHKEY'=None,hwnd:'int'=None) -> 'None': """ - Initializes the IQueryAssociations interface and sets the root key to the + Initializes the IQueryAssociations interface and sets the root key to the appropriate ProgID. @@ -29214,14 +29218,14 @@ Args: Returns: None - + """ pass def GetKey(self,flags:'typing.Any',assocKey:'typing.Any',arg:'str') -> 'typing.Any': """ - Searches for and retrieves a file association-related key from the + Searches for and retrieves a file association-related key from the registry. @@ -29234,14 +29238,14 @@ Args: Returns: typing.Any - + """ pass def GetString(self,flags:'typing.Any',assocStr:'typing.Any',arg:'str') -> 'typing.Any': """ - Searches for and retrieves a file association-related string from the + Searches for and retrieves a file association-related string from the registry. @@ -29254,13 +29258,13 @@ Args: Returns: typing.Any - + """ pass class PyIRelatedItem(object): - """Interface used as the base for objects that have a related shell item + """Interface used as the base for objects that have a related shell item (eg ITransferMediumItem, IDisplayItem, etc). Should not be used directly.""" @@ -29279,7 +29283,7 @@ Args: Returns: PyIDL - + """ pass @@ -29295,7 +29299,7 @@ Args: Returns: PyIShellItem - + """ pass @@ -29320,14 +29324,14 @@ Args: Returns: None - + """ pass def CauseBreak(self,) -> 'None': """ - Causes the application to break into the debugger at the earliest + Causes the application to break into the debugger at the earliest opportunity. @@ -29338,7 +29342,7 @@ Args: Returns: None - + """ pass @@ -29354,7 +29358,7 @@ Args: Returns: None - + """ pass @@ -29370,14 +29374,14 @@ Args: Returns: None - + """ pass def GetDebugger(self,) -> 'PyIApplicationDebugger': """ - Returns the current debugger connected to + Returns the current debugger connected to the application. @@ -29388,14 +29392,14 @@ Args: Returns: PyIApplicationDebugger - + """ pass def CreateInstanceAtApplication(self,rclsid:'PyIID',pUnkOuter:'PyIUnknown',dwClsContext:'typing.Any',riid:'PyIID') -> 'PyIUnknown': """ - Create objects in the application + Create objects in the application process address space. @@ -29409,7 +29413,7 @@ Args: Returns: PyIUnknown - + """ pass @@ -29425,14 +29429,14 @@ Args: Returns: None - + """ pass def EnumThreads(self,) -> 'PyIEnumRemoteDebugApplicationThreads': """ - Enumerates all threads known + Enumerates all threads known to be associated with the application. @@ -29443,7 +29447,7 @@ Args: Returns: PyIEnumRemoteDebugApplicationThreads - + """ pass @@ -29459,14 +29463,14 @@ Args: Returns: None - + """ pass def GetRootNode(self,) -> 'PyIDebugApplicationNode': """ - Returns the application node under which + Returns the application node under which all nodes associated with the application are added. @@ -29477,14 +29481,14 @@ Args: Returns: PyIDebugApplicationNode - + """ pass def EnumGlobalExpressionContexts(self,) -> 'typing.Any': """ - Enumerates all + Enumerates all global expression contexts @@ -29495,7 +29499,7 @@ Args: Returns: typing.Any - + """ pass @@ -29518,7 +29522,7 @@ Args: Returns: None - + """ pass @@ -29534,7 +29538,7 @@ Args: Returns: None - + """ pass @@ -29550,7 +29554,7 @@ Args: Returns: None - + """ pass @@ -29566,7 +29570,7 @@ Args: Returns: None - + """ pass @@ -29582,7 +29586,7 @@ Args: Returns: None - + """ pass @@ -29598,7 +29602,7 @@ Args: Returns: None - + """ pass @@ -29614,7 +29618,7 @@ Args: Returns: None - + """ pass @@ -29630,7 +29634,7 @@ Args: Returns: None - + """ pass @@ -29646,7 +29650,7 @@ Args: Returns: None - + """ pass @@ -29663,7 +29667,7 @@ Args: Returns: None - + """ pass @@ -29686,7 +29690,7 @@ Args: Returns: None - + """ pass @@ -29702,7 +29706,7 @@ Args: Returns: None - + """ pass @@ -29718,7 +29722,7 @@ Args: Returns: None - + """ pass @@ -29734,7 +29738,7 @@ Args: Returns: None - + """ pass @@ -29751,7 +29755,7 @@ Args: Returns: None - + """ pass @@ -29767,7 +29771,7 @@ Args: Returns: None - + """ pass @@ -29783,7 +29787,7 @@ Args: Returns: None - + """ pass @@ -29799,7 +29803,7 @@ Args: Returns: None - + """ pass @@ -29815,7 +29819,7 @@ Args: Returns: None - + """ pass @@ -29829,7 +29833,7 @@ class PyIRunningObjectTable(object): def Register(self,) -> 'typing.Any': """ - Registers an object and its identifying moniker in the Running Object + Registers an object and its identifying moniker in the Running Object Table (ROT). @@ -29840,7 +29844,7 @@ Args: Returns: typing.Any - + """ pass @@ -29856,7 +29860,7 @@ Args: Returns: typing.Any - + """ pass @@ -29872,7 +29876,7 @@ Args: Returns: typing.Any - + """ pass @@ -29888,14 +29892,14 @@ Args: Returns: PyIUnknown - + """ pass def EnumRunning(self,) -> 'PyIEnumMoniker': """ - Creates an enumerator that can list the monikers of + Creates an enumerator that can list the monikers of all the objects currently registered in the Running Object Table (ROT). @@ -29906,7 +29910,7 @@ Args: Returns: PyIEnumMoniker - + """ pass @@ -29920,7 +29924,7 @@ class PyIScheduledWorkItem(object): def CreateTrigger(self,) -> 'typing.Tuple[typing.Any, PyITaskTrigger]': """ - Creates a new trigger for a task, returns index and + Creates a new trigger for a task, returns index and new ITaskTrigger interface @@ -29931,7 +29935,7 @@ Args: Returns: typing.Tuple[typing.Any, PyITaskTrigger] - + """ pass @@ -29947,7 +29951,7 @@ Args: Returns: None - + """ pass @@ -29963,14 +29967,14 @@ Args: Returns: typing.Any - + """ pass def GetTrigger(self,iTrigger:'typing.Any') -> 'PyITaskTrigger': """ - Retrieves ITaskTrigger interface for specified trigger + Retrieves ITaskTrigger interface for specified trigger index @@ -29981,7 +29985,7 @@ Args: Returns: PyITaskTrigger - + """ pass @@ -29997,14 +30001,14 @@ Args: Returns: typing.Any - + """ pass def GetRunTimes(self,Count:'typing.Any',Begin:'PyTime',End:'PyTime') -> 'typing.Tuple[PyTime, typing.Any, typing.Any, typing.Any]': """ - Return specified number of run times within given time + Return specified number of run times within given time frame @@ -30017,7 +30021,7 @@ Args: Returns: typing.Tuple[PyTime, typing.Any, typing.Any, typing.Any] - + """ pass @@ -30033,7 +30037,7 @@ Args: Returns: PyTime - + """ pass @@ -30050,14 +30054,14 @@ Args: Returns: None - + """ pass def GetIdleWait(self,) -> 'typing.Tuple[typing.Any, typing.Any]': """ - Gets IdleMinutes and DeadlineMinutes parms for task with trigger + Gets IdleMinutes and DeadlineMinutes parms for task with trigger of type TASK_EVENT_TRIGGER_ON_IDLE @@ -30068,7 +30072,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -30084,7 +30088,7 @@ Args: Returns: None - + """ pass @@ -30100,7 +30104,7 @@ Args: Returns: None - + """ pass @@ -30117,7 +30121,7 @@ Args: Returns: None - + """ pass @@ -30133,7 +30137,7 @@ Args: Returns: PyTime - + """ pass @@ -30149,14 +30153,14 @@ Args: Returns: typing.Any - + """ pass def GetExitCode(self,) -> 'typing.Tuple[typing.Any, typing.Any]': """ - Returns tuple of task's exit code and error returned to Task + Returns tuple of task's exit code and error returned to Task Scheduler if process could not start @@ -30167,7 +30171,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -30183,7 +30187,7 @@ Args: Returns: None - + """ pass @@ -30199,7 +30203,7 @@ Args: Returns: str - + """ pass @@ -30215,7 +30219,7 @@ Args: Returns: None - + """ pass @@ -30231,7 +30235,7 @@ Args: Returns: None - + """ pass @@ -30247,7 +30251,7 @@ Args: Returns: None - + """ pass @@ -30263,14 +30267,14 @@ Args: Returns: str - + """ pass def SetErrorRetryCount(self,wRetryCount:'typing.Any') -> 'None': """ - Specify nbr of times to attempt to run task if it can't start (not + Specify nbr of times to attempt to run task if it can't start (not currently implemented) @@ -30281,14 +30285,14 @@ Args: Returns: None - + """ pass def GetErrorRetryCount(self,) -> 'None': """ - Return nbr of times Task scheduler should try to run task (not + Return nbr of times Task scheduler should try to run task (not currently implemented) @@ -30299,14 +30303,14 @@ Args: Returns: None - + """ pass def SetErrorRetryInterval(self,RetryInterval:'typing.Any') -> 'None': """ - Interval in minutes between attempts to run task. Not + Interval in minutes between attempts to run task. Not implemented according to SDK @@ -30317,14 +30321,14 @@ Args: Returns: None - + """ pass def GetErrorRetryInterval(self,) -> 'None': """ - Returns nbr of minutes between attempts to run task. Not + Returns nbr of minutes between attempts to run task. Not implemented according to SDK @@ -30335,7 +30339,7 @@ Args: Returns: None - + """ pass @@ -30351,7 +30355,7 @@ Args: Returns: None - + """ pass @@ -30367,7 +30371,7 @@ Args: Returns: typing.Any - + """ pass @@ -30384,7 +30388,7 @@ Args: Returns: None - + """ pass @@ -30400,7 +30404,7 @@ Args: Returns: typing.Any - + """ pass @@ -30423,7 +30427,7 @@ Args: Returns: typing.Any - + """ pass @@ -30439,7 +30443,7 @@ Args: Returns: None - + """ pass @@ -30455,7 +30459,7 @@ Args: Returns: None - + """ pass @@ -30471,7 +30475,7 @@ Args: Returns: typing.Any - + """ pass @@ -30485,7 +30489,7 @@ class PyIServiceProvider(object): def QueryService(self,clsid:'PyIID',iid:'PyIID') -> 'PyIUnknown': """ - Creates or accesses the specified service and returns an + Creates or accesses the specified service and returns an interface object to the specified interface for the service. @@ -30497,13 +30501,13 @@ Args: Returns: PyIUnknown - + """ pass class PyIShellBrowser(object): - """Exposed by Windows Explorer and the Open File common dialog box to provide services for + """Exposed by Windows Explorer and the Open File common dialog box to provide services for namespace extensions.""" @@ -30523,7 +30527,7 @@ Args: Returns: PyOLEMENUGROUPWIDTHS - + """ pass @@ -30541,7 +30545,7 @@ Args: Returns: None - + """ pass @@ -30557,7 +30561,7 @@ Args: Returns: None - + """ pass @@ -30573,7 +30577,7 @@ Args: Returns: None - + """ pass @@ -30589,7 +30593,7 @@ Args: Returns: None - + """ pass @@ -30606,7 +30610,7 @@ Args: Returns: None - + """ pass @@ -30623,14 +30627,14 @@ Args: Returns: None - + """ pass def GetViewStateStream(self,grfMode:'typing.Any') -> 'PyIStream': """ - Returns a stream that can be used to access view state + Returns a stream that can be used to access view state information @@ -30641,7 +30645,7 @@ Args: Returns: PyIStream - + """ pass @@ -30657,7 +30661,7 @@ Args: Returns: None - + """ pass @@ -30676,7 +30680,7 @@ Args: Returns: typing.Any - + """ pass @@ -30692,7 +30696,7 @@ Args: Returns: PyIShellView - + """ pass @@ -30708,7 +30712,7 @@ Args: Returns: None - + """ pass @@ -30725,7 +30729,7 @@ Args: Returns: None - + """ pass @@ -30750,7 +30754,7 @@ Args: Returns: None - + """ pass @@ -30784,7 +30788,7 @@ specifies the relative path from the parsing folder to the object [2] int : Attributes returns any requested attributes - + """ pass @@ -30801,7 +30805,7 @@ Args: Returns: PyIEnumIDList - + """ pass @@ -30819,7 +30823,7 @@ Args: Returns: PyIShellFolder - + """ pass @@ -30838,7 +30842,7 @@ Returns: typing.Any:IID of the desired interface, one of IID_IStream, IID_IStorage, IID_IPropertySetStorageReturn ValueReturns PyIStream, PyIStorage or PyIPropertySetStorage depending on the riid passed in - + """ pass @@ -30857,7 +30861,7 @@ Returns: typing.Any:Item id list that idenfies an object relative to the folderReturn ValueReturns 0 if items compare equal, -1 if the pidl1 comes first, or 1 if pidl2 comes first - + """ pass @@ -30874,7 +30878,7 @@ Args: Returns: PyIShellView - + """ pass @@ -30892,14 +30896,14 @@ Returns: typing.Any:Combination of shellcon.SFGAO_* constantsReturn ValueThe requested attributes are only returned if they are common to all of the specified items - + """ pass def GetUIObjectOf(self,hwndOwner:'int',pidl:'typing.Tuple[PyIDL, ...]',riid:'PyIID',iidout:'PyIID',Reserved:'typing.Any'=0) -> 'typing.Tuple[typing.Any, PyIUnknown]': """ - Creates an interface to one or more items in a shell + Creates an interface to one or more items in a shell folder @@ -30913,16 +30917,16 @@ Args: Returns: - typing.Tuple[typing.Any, PyIUnknown]:The interface to return. Can be used in the case where there is not a + typing.Tuple[typing.Any, PyIUnknown]:The interface to return. Can be used in the case where there is not a -python wrapper for the desired interface. You must make certain that the interface identified by riid +python wrapper for the desired interface. You must make certain that the interface identified by riid -actually supports the iidout interface, or Bad Things Will Happen. +actually supports the iidout interface, or Bad Things Will Happen. It should always be safe to return PyIUnknown, which is the base for all interfaces. Return ValueReturns the Reserved parameter and the requested interface - + """ pass @@ -30939,7 +30943,7 @@ Args: Returns: typing.Any - + """ pass @@ -30959,7 +30963,7 @@ Returns: PyIDL:Combination of shellcon.SHGDM_* valuesReturn ValueReturns the new PIDL for item - + """ pass @@ -30982,14 +30986,14 @@ Args: Returns: PyIID - + """ pass def EnumSearches(self,) -> 'typing.Any': """ - Returns an interface that lists searches defined for + Returns an interface that lists searches defined for the folder @@ -31000,7 +31004,7 @@ Args: Returns: typing.Any - + """ pass @@ -31016,7 +31020,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -31033,7 +31037,7 @@ Returns: typing.Any:Zero-based index of the columnReturn ValueReturns a combination of shellcon.SHCOLSTATE_* flags - + """ pass @@ -31051,14 +31055,14 @@ Returns: typing.Any:The Column id/property key of a column in the folder's Details viewReturn ValueThe type of returned object is determined by the variant type of the requested column - + """ pass def GetDetailsOf(self,pidl:'PyIDL',iColumn:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': """ - Returns the value or title of a column in the folder's Details + Returns the value or title of a column in the folder's Details view. @@ -31069,13 +31073,13 @@ Args: Returns: - typing.Tuple[typing.Any, typing.Any, typing.Any]:Zero based index of columnReturn ValueReturns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in + typing.Tuple[typing.Any, typing.Any, typing.Any]:Zero based index of columnReturn ValueReturns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in -characters, +characters, and string representation of the requested value - + """ pass @@ -31090,11 +31094,11 @@ Args: Returns: - typing.Any:The zero-based index of the column as presented by the folder's Details viewReturn ValueOn XP and earlier, this is the Column Id as provided by PyIColumnProvider. + typing.Any:The zero-based index of the column as presented by the folder's Details viewReturn ValueOn XP and earlier, this is the Column Id as provided by PyIColumnProvider. For Vista and later, this is the Property Key used with the property system interfaces. - + """ pass @@ -31117,7 +31121,7 @@ Args: Returns: None - + """ pass @@ -31140,7 +31144,7 @@ Args: Returns: None - + """ pass @@ -31156,7 +31160,7 @@ Args: Returns: None - + """ pass @@ -31179,22 +31183,22 @@ Args: Returns: - typing.Any:Shell attributes, combination of shellcon.SFGAO_* flagsReturn ValueThe gateway implementation of this function should return winerror.S_OK to + typing.Any:Shell attributes, combination of shellcon.SFGAO_* flagsReturn ValueThe gateway implementation of this function should return winerror.S_OK to -display the overlay, S_FALSE if not, or throw a COM exception with E_FAIL on error. +display the overlay, S_FALSE if not, or throw a COM exception with E_FAIL on error. -The client implementation of this function returns the same values - ie, +The client implementation of this function returns the same values - ie, Python's True and False should not be used, as S_OK==0==False. - + """ pass def GetOverlayInfo(self,) -> 'typing.Tuple[str, typing.Any, typing.Any]': """ - Retrieves the path to the overlay + Retrieves the path to the overlay icon @@ -31206,14 +31210,14 @@ Returns: typing.Tuple[str, typing.Any, typing.Any]:PyIShellIconOverlayIdentifier.GetOverlayInfo -(PyUnicode, int, int) = GetOverlayInfo()Retrieves the path to the overlay +(PyUnicode, int, int) = GetOverlayInfo()Retrieves the path to the overlay icon -Return ValueReturns the path to the icon file, the index of icon within the file, and Flags containing +Return ValueReturns the path to the icon file, the index of icon within the file, and Flags containing combination of shellcon.ISIOI_ICON* flags - + """ pass @@ -31233,7 +31237,7 @@ Returns: int = GetPriority()Retrieves the relative priority of the overlay Return ValueImplementation of this function should return a number in the range 0-100 (0 is highest priority) - + """ pass @@ -31247,7 +31251,7 @@ class PyIShellIconOverlayManager(object): def GetFileOverlayInfo(self,path:'typing.Any',attrib:'typing.Any',flags:'typing.Any') -> 'typing.Any': """ - Returns an index into the system image list for the icon + Returns an index into the system image list for the icon image or overlay image @@ -31260,7 +31264,7 @@ Args: Returns: typing.Any - + """ pass @@ -31279,7 +31283,7 @@ Args: Returns: None - + """ pass @@ -31295,7 +31299,7 @@ Args: Returns: None - + """ pass @@ -31311,7 +31315,7 @@ Args: Returns: None - + """ pass @@ -31328,7 +31332,7 @@ Args: Returns: None - + """ pass @@ -31353,7 +31357,7 @@ Args: Returns: typing.Any - + """ pass @@ -31369,7 +31373,7 @@ Args: Returns: PyIShellItem - + """ pass @@ -31385,7 +31389,7 @@ Args: Returns: typing.Any - + """ pass @@ -31402,7 +31406,7 @@ Returns: typing.Any:Combination of shellcon.SFGAO_* values indicating the flags to returnReturn ValueReturns a combination of shellcon.SFGAO_* values - + """ pass @@ -31420,7 +31424,7 @@ Returns: typing.Any:shellcon.SICHINT_* value indicating how the comparison is to be performedReturn ValueReturns 0 if items compare as equal, nonzero otherwise - + """ pass @@ -31444,14 +31448,14 @@ Args: Returns: PyIPropertyStore - + """ pass def GetPropertyStoreForKeys(self,Keys:'typing.Tuple[typing.Any, ...]',Flags:'typing.Any',riid:'PyIID') -> 'PyIPropertyStore': """ - Creates a property store containing just the + Creates a property store containing just the specified properties of the item @@ -31464,14 +31468,14 @@ Args: Returns: PyIPropertyStore - + """ pass def GetPropertyStoreWithCreateObject(self,Flags:'typing.Any',CreateObject:'PyIUnknown',riid:'PyIID') -> 'PyIPropertyStore': """ - Returns the property store for the + Returns the property store for the item, with alternate handler instantiation @@ -31484,14 +31488,14 @@ Args: Returns: PyIPropertyStore - + """ pass def GetPropertyDescriptionList(self,Type:'PyPROPERTYKEY',riid:'PyIID') -> 'PyIPropertyDescriptionList': """ - Retrieves descriptions of + Retrieves descriptions of properties in a particular group @@ -31503,7 +31507,7 @@ Args: Returns: PyIPropertyDescriptionList - + """ pass @@ -31519,7 +31523,7 @@ Args: Returns: None - + """ pass @@ -31536,7 +31540,7 @@ Returns: typing.Any:The id of the property to retrieveReturn ValueType of returned object is determined by the variant type of the property - + """ pass @@ -31552,7 +31556,7 @@ Args: Returns: PyIID - + """ pass @@ -31568,7 +31572,7 @@ Args: Returns: PyTime - + """ pass @@ -31584,7 +31588,7 @@ Args: Returns: typing.Any - + """ pass @@ -31600,7 +31604,7 @@ Args: Returns: typing.Any - + """ pass @@ -31616,7 +31620,7 @@ Args: Returns: typing.Any - + """ pass @@ -31632,7 +31636,7 @@ Args: Returns: typing.Any - + """ pass @@ -31648,7 +31652,7 @@ Args: Returns: typing.Any - + """ pass @@ -31673,14 +31677,14 @@ Args: Returns: typing.Any - + """ pass def GetPropertyStore(self,flags:'typing.Any',riid:'PyIID') -> 'PyIPropertyStore': """ - Retrieves a store containing consolidated + Retrieves a store containing consolidated properties of items in container @@ -31692,14 +31696,14 @@ Args: Returns: PyIPropertyStore - + """ pass def GetPropertyDescriptionList(self,Type:'PyPROPERTYKEY',riid:'PyIID') -> 'PyIPropertyDescriptionList': """ - Retrieves descriptions for a + Retrieves descriptions for a defined group of properties @@ -31711,7 +31715,7 @@ Args: Returns: PyIPropertyDescriptionList - + """ pass @@ -31728,7 +31732,7 @@ Args: Returns: typing.Any - + """ pass @@ -31744,7 +31748,7 @@ Args: Returns: typing.Any - + """ pass @@ -31760,7 +31764,7 @@ Args: Returns: PyIShellItem - + """ pass @@ -31776,7 +31780,7 @@ Args: Returns: PyIEnumShellItems - + """ pass @@ -31799,7 +31803,7 @@ Args: Returns: None - + """ pass @@ -31815,7 +31819,7 @@ Args: Returns: typing.Any - + """ pass @@ -31831,7 +31835,7 @@ Args: Returns: None - + """ pass @@ -31849,7 +31853,7 @@ Args: Returns: None - + """ pass @@ -31865,7 +31869,7 @@ Args: Returns: None - + """ pass @@ -31881,7 +31885,7 @@ Args: Returns: PyIEnumResources - + """ pass @@ -31897,7 +31901,7 @@ Args: Returns: typing.Any - + """ pass @@ -31914,7 +31918,7 @@ Args: Returns: PyIUnknown - + """ pass @@ -31931,7 +31935,7 @@ Args: Returns: typing.Any - + """ pass @@ -31947,7 +31951,7 @@ Args: Returns: None - + """ pass @@ -31971,7 +31975,7 @@ Args: Returns: None - + """ pass @@ -31988,7 +31992,7 @@ Args: Returns: None - + """ pass @@ -32004,7 +32008,7 @@ Args: Returns: None - + """ pass @@ -32020,7 +32024,7 @@ Args: Returns: None - + """ pass @@ -32037,7 +32041,7 @@ Args: Returns: PyIShellItemArray - + """ pass @@ -32055,14 +32059,14 @@ Args: Returns: PyIShellItem - + """ pass def GetDefaultSaveFolder(self,Type:'typing.Any',riid:'PyIID') -> 'PyIShellItem': """ - Returns the default folder in which new items are + Returns the default folder in which new items are saved @@ -32074,7 +32078,7 @@ Args: Returns: PyIShellItem - + """ pass @@ -32091,7 +32095,7 @@ Args: Returns: None - + """ pass @@ -32111,7 +32115,7 @@ Returns: int = GetOptions()Retrieves library option flags Return ValueReturns a combination of shellcon.LOF_* flags - + """ pass @@ -32128,7 +32132,7 @@ Args: Returns: None - + """ pass @@ -32144,7 +32148,7 @@ Args: Returns: PyIID - + """ pass @@ -32160,7 +32164,7 @@ Args: Returns: None - + """ pass @@ -32180,7 +32184,7 @@ Returns: str = GetIcon()Returns the location of the library's icon Return ValueUses "module,resource" format - + """ pass @@ -32196,7 +32200,7 @@ Args: Returns: None - + """ pass @@ -32212,7 +32216,7 @@ Args: Returns: None - + """ pass @@ -32231,7 +32235,7 @@ Returns: PyIShellItem:Determines behaviour if file already exists, shellcon.LSF_*Return ValueReturns a shell item for the saved file. - + """ pass @@ -32249,7 +32253,7 @@ Args: Returns: PyIShellItem - + """ pass @@ -32263,7 +32267,7 @@ class PyIShellLink(object): def GetPath(self,fFlags:'typing.Any',cchMaxPath:'typing.Any') -> 'typing.Tuple[typing.Any, WIN32_FIND_DATA]': """ - Retrieves the target path and file name of a shell link + Retrieves the target path and file name of a shell link object @@ -32275,7 +32279,7 @@ Args: Returns: typing.Tuple[typing.Any, WIN32_FIND_DATA] - + """ pass @@ -32291,7 +32295,7 @@ Args: Returns: PyIDL - + """ pass @@ -32307,7 +32311,7 @@ Args: Returns: None - + """ pass @@ -32323,7 +32327,7 @@ Args: Returns: typing.Any - + """ pass @@ -32339,7 +32343,7 @@ Args: Returns: None - + """ pass @@ -32355,7 +32359,7 @@ Args: Returns: typing.Any - + """ pass @@ -32371,7 +32375,7 @@ Args: Returns: None - + """ pass @@ -32387,7 +32391,7 @@ Args: Returns: typing.Any - + """ pass @@ -32403,7 +32407,7 @@ Args: Returns: None - + """ pass @@ -32419,7 +32423,7 @@ Args: Returns: typing.Any - + """ pass @@ -32435,7 +32439,7 @@ Args: Returns: None - + """ pass @@ -32451,7 +32455,7 @@ Args: Returns: typing.Any - + """ pass @@ -32467,14 +32471,14 @@ Args: Returns: None - + """ pass def GetIconLocation(self,cchMaxPath:'typing.Any') -> 'typing.Any': """ - Retrieves the location (path and index) of the icon for a shell link + Retrieves the location (path and index) of the icon for a shell link object. @@ -32485,7 +32489,7 @@ Args: Returns: typing.Any - + """ pass @@ -32502,7 +32506,7 @@ Args: Returns: None - + """ pass @@ -32519,14 +32523,14 @@ Args: Returns: None - + """ pass def Resolve(self,hwnd:'typing.Any',fFlags:'typing.Any') -> 'None': """ - Resolves a shell link by searching for the shell link object and updating the + Resolves a shell link by searching for the shell link object and updating the shell link path and its list of identifiers (if necessary) @@ -32538,7 +32542,7 @@ Args: Returns: None - + """ pass @@ -32554,7 +32558,7 @@ Args: Returns: None - + """ pass @@ -32577,7 +32581,7 @@ Args: Returns: None - + """ pass @@ -32594,7 +32598,7 @@ Returns: typing.Any:The type of data block to retrieve, one of the shellcon.*_SIG constantsReturn ValueThe returned dictionary will contain different information depending on the value passed in - + """ pass @@ -32614,7 +32618,7 @@ Returns: int = GetFlags()Retrieves the link's flags Return ValueReturns combination of shellcon.SLDF_* flags - + """ pass @@ -32630,7 +32634,7 @@ Args: Returns: None - + """ pass @@ -32646,7 +32650,7 @@ Args: Returns: None - + """ pass @@ -32670,7 +32674,7 @@ Returns: typing.Any:Description for pmsgReturn ValueThe result is the HRESULT from the underlying TranslateAccelerator call - + """ pass @@ -32686,7 +32690,7 @@ Args: Returns: None - + """ pass @@ -32702,7 +32706,7 @@ Args: Returns: None - + """ pass @@ -32718,7 +32722,7 @@ Args: Returns: None - + """ pass @@ -32738,7 +32742,7 @@ Returns: typing.Any:Description for prcViewReturn ValueThe result is an integer handle to the new window. - + """ pass @@ -32754,7 +32758,7 @@ Args: Returns: None - + """ pass @@ -32770,7 +32774,7 @@ Args: Returns: typing.Any - + """ pass @@ -32786,7 +32790,7 @@ Args: Returns: None - + """ pass @@ -32803,7 +32807,7 @@ Args: Returns: None - + """ pass @@ -32820,7 +32824,7 @@ Args: Returns: PyIUnknown - + """ pass @@ -32843,7 +32847,7 @@ Args: Returns: None - + """ pass @@ -32857,9 +32861,9 @@ class PyIStorage(object): def CreateStream(self,Name:'typing.Any',Mode:'typing.Any',reserved1:'typing.Any'=0,reserved2:'typing.Any'=0) -> 'PyIStream': """ - Creates and opens a stream object with the specified name contained + Creates and opens a stream object with the specified name contained -in this storage object. All elements within a storage object — both streams and other storage objects — are kept in +in this storage object. All elements within a storage object — both streams and other storage objects — are kept in the same name space. @@ -32873,14 +32877,14 @@ Args: Returns: PyIStream - + """ pass def OpenStream(self,Name:'typing.Any',reserved1:'typing.Any',Mode:'typing.Any',reserved2:'typing.Any'=0) -> 'PyIStream': """ - Opens an existing stream object within this storage object in the + Opens an existing stream object within this storage object in the specified access mode. @@ -32894,14 +32898,14 @@ Args: Returns: PyIStream - + """ pass def CreateStorage(self,Name:'typing.Any',Mode:'typing.Any',StgFmt:'typing.Any',reserved2:'typing.Any'=0) -> 'PyIStorage': """ - Creates and opens a new storage object nested within this storage + Creates and opens a new storage object nested within this storage object. @@ -32915,14 +32919,14 @@ Args: Returns: PyIStorage - + """ pass def OpenStorage(self,Name:'typing.Any',Priority:'PyIStorage',Mode:'typing.Any',snbExclude:'typing.Any',reserved:'typing.Any'=0) -> 'PyIStorage': """ - Opens an existing storage object with the specified name in the + Opens an existing storage object with the specified name in the specified access mode. @@ -32937,7 +32941,7 @@ Args: Returns: PyIStorage - + """ pass @@ -32955,14 +32959,14 @@ Args: Returns: None - + """ pass def MoveElementTo(self,Name:'typing.Any',stgDest:'PyIStorage',NewName:'typing.Any',Flags:'typing.Any') -> 'None': """ - Copies or moves a substorage or stream from this storage object to another + Copies or moves a substorage or stream from this storage object to another storage object. @@ -32976,18 +32980,18 @@ Args: Returns: None - + """ pass def Commit(self,grfCommitFlags:'typing.Any') -> 'None': """ - Ensures that any changes made to a storage object open in transacted mode are reflected + Ensures that any changes made to a storage object open in transacted mode are reflected -in the parent storage; for a root storage, reflects the changes in the actual device, for example, a file on disk. +in the parent storage; for a root storage, reflects the changes in the actual device, for example, a file on disk. -For a root storage object opened in direct mode, this method has no effect except to flush all memory buffers to the +For a root storage object opened in direct mode, this method has no effect except to flush all memory buffers to the disk. For non-root storage objects in direct mode, this method has no effect. @@ -32998,7 +33002,7 @@ Args: Returns: None - + """ pass @@ -33014,14 +33018,14 @@ Args: Returns: None - + """ pass def EnumElements(self,reserved1:'typing.Any'=0,reserved2:'typing.Any'=None,reserved3:'typing.Any'=0) -> 'PyIEnumSTATSTG': """ - Retrieves an enumerator object that can be used to enumerate the + Retrieves an enumerator object that can be used to enumerate the storage and stream objects contained within this storage object. @@ -33034,7 +33038,7 @@ Args: Returns: PyIEnumSTATSTG - + """ pass @@ -33050,7 +33054,7 @@ Args: Returns: None - + """ pass @@ -33067,14 +33071,14 @@ Args: Returns: None - + """ pass def SetElementTimes(self,name:'typing.Any',ctime:'PyTime',atime:'PyTime',mtime:'PyTime') -> 'None': """ - Sets the modification, access, and creation times of the specified storage + Sets the modification, access, and creation times of the specified storage element, if supported by the underlying file system. @@ -33088,7 +33092,7 @@ Args: Returns: None - + """ pass @@ -33104,7 +33108,7 @@ Args: Returns: None - + """ pass @@ -33121,7 +33125,7 @@ Args: Returns: None - + """ pass @@ -33137,7 +33141,7 @@ Args: Returns: STATSTG - + """ pass @@ -33161,7 +33165,7 @@ Returns: str:The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - + """ pass @@ -33178,7 +33182,7 @@ Returns: str:The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - + """ pass @@ -33194,7 +33198,7 @@ Args: Returns: None - + """ pass @@ -33210,7 +33214,7 @@ Args: Returns: None - + """ pass @@ -33227,7 +33231,7 @@ Args: Returns: ULARGE_INTEGER - + """ pass @@ -33243,14 +33247,14 @@ Args: Returns: None - + """ pass def CopyTo(self,stream:'PyIStream',cb:'ULARGE_INTEGER') -> 'ULARGE_INTEGER': """ - Copies a specified number of bytes from the current seek pointer in the + Copies a specified number of bytes from the current seek pointer in the stream to the current seek pointer in another stream. @@ -33263,14 +33267,14 @@ Returns: ULARGE_INTEGER:The number of bytes to write.Return ValueThe return value is the number of bytes actually written. - + """ pass def Commit(self,flags:'typing.Any') -> 'None': """ - Ensures that any changes made to a stream object open in transacted mode are reflected in + Ensures that any changes made to a stream object open in transacted mode are reflected in the parent storage. @@ -33281,7 +33285,7 @@ Args: Returns: None - + """ pass @@ -33297,7 +33301,7 @@ Args: Returns: None - + """ pass @@ -33315,7 +33319,7 @@ Args: Returns: None - + """ pass @@ -33333,14 +33337,14 @@ Args: Returns: None - + """ pass def Clone(self,) -> 'PyIStream': """ - Creates a new stream object with its own seek pointer that references the + Creates a new stream object with its own seek pointer that references the same bytes as the original stream. @@ -33351,7 +33355,7 @@ Args: Returns: PyIStream - + """ pass @@ -33367,7 +33371,7 @@ Args: Returns: STATSTG - + """ pass @@ -33390,7 +33394,7 @@ Args: Returns: None - + """ pass @@ -33406,7 +33410,7 @@ Args: Returns: typing.Any - + """ pass @@ -33422,7 +33426,7 @@ Args: Returns: None - + """ pass @@ -33438,7 +33442,7 @@ Args: Returns: typing.Any - + """ pass @@ -33454,7 +33458,7 @@ Args: Returns: None - + """ pass @@ -33470,7 +33474,7 @@ Args: Returns: typing.Any - + """ pass @@ -33486,7 +33490,7 @@ Args: Returns: None - + """ pass @@ -33502,7 +33506,7 @@ Args: Returns: typing.Any - + """ pass @@ -33518,7 +33522,7 @@ Args: Returns: None - + """ pass @@ -33534,7 +33538,7 @@ Args: Returns: typing.Any - + """ pass @@ -33550,7 +33554,7 @@ Args: Returns: None - + """ pass @@ -33566,7 +33570,7 @@ Args: Returns: typing.Any - + """ pass @@ -33589,14 +33593,14 @@ Args: Returns: None - + """ pass def GetTargetComputer(self,) -> 'typing.Any': """ - Returns name of computer that the Task Scheduler is + Returns name of computer that the Task Scheduler is connected to @@ -33607,7 +33611,7 @@ Args: Returns: typing.Any - + """ pass @@ -33623,7 +33627,7 @@ Args: Returns: typing.Tuple[str, ...] - + """ pass @@ -33640,7 +33644,7 @@ Args: Returns: PyITask - + """ pass @@ -33656,7 +33660,7 @@ Args: Returns: None - + """ pass @@ -33674,7 +33678,7 @@ Args: Returns: PyITask - + """ pass @@ -33691,7 +33695,7 @@ Args: Returns: None - + """ pass @@ -33708,7 +33712,7 @@ Args: Returns: None - + """ pass @@ -33731,7 +33735,7 @@ Args: Returns: None - + """ pass @@ -33747,7 +33751,7 @@ Args: Returns: PyTASK_TRIGGER - + """ pass @@ -33763,7 +33767,7 @@ Args: Returns: str - + """ pass @@ -33786,7 +33790,7 @@ Args: Returns: None - + """ pass @@ -33802,7 +33806,7 @@ Args: Returns: None - + """ pass @@ -33818,7 +33822,7 @@ Args: Returns: None - + """ pass @@ -33834,14 +33838,14 @@ Args: Returns: None - + """ pass def SetActiveAlt(self,hwnd:'int') -> 'None': """ - Sets the window as the active tab, without displaying it as pressed on the + Sets the window as the active tab, without displaying it as pressed on the taskbar @@ -33852,7 +33856,7 @@ Args: Returns: None - + """ pass @@ -33880,7 +33884,7 @@ Args: Returns: None - + """ pass @@ -33896,7 +33900,7 @@ Args: Returns: None - + """ pass @@ -33914,14 +33918,14 @@ Args: Returns: typing.Any - + """ pass def ConfirmEncryptionLoss(self,Source:'PyIShellItem') -> 'typing.Any': """ - Notifies user when an item can't be encrypted at + Notifies user when an item can't be encrypted at destination @@ -33932,7 +33936,7 @@ Args: Returns: typing.Any - + """ pass @@ -33951,14 +33955,14 @@ Returns: typing.Tuple[typing.Any, typing.Any]:HRESULT error code from operationReturn ValueReturns the HRESULT and new file name if renaming resolved the failure - + """ pass def SubStreamFailure(self,Item:'PyIShellItem',StreamName:'typing.Any',Error:'typing.Any') -> 'typing.Any': """ - Notifies user of failure on a substream, and queries how to + Notifies user of failure on a substream, and queries how to proceed @@ -33972,7 +33976,7 @@ Returns: typing.Any:HRESULT failure code from operationReturn ValueReturns COPYENGINE_S_* if operation is to continue, or COPYENGINE_E_* HRESULT if cancelled - + """ pass @@ -33989,11 +33993,11 @@ Args: Returns: - typing.Any:HRESULT error code returned by the operationReturn ValueReturns COPYENGINE_S_* to indicate that the failure was handled, or + typing.Any:HRESULT error code returned by the operationReturn ValueReturns COPYENGINE_S_* to indicate that the failure was handled, or COPYENGINE_E_USERCANCELLED to cancel pending operations - + """ pass @@ -34017,7 +34021,7 @@ Returns: typing.Any:Event sink to receive notificationsReturn ValueReturns an id for the connection, to be passed to PyITransferDestination::Unadvise - + """ pass @@ -34033,7 +34037,7 @@ Args: Returns: None - + """ pass @@ -34054,11 +34058,11 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any]:Resource interface to return -Return ValueReturns the HRESULT and requested interfaces. Interfaces may be None if +Return ValueReturns the HRESULT and requested interfaces. Interfaces may be None if function returns one of the informational codes (shellcon.COPYENGINE_S_*) - + """ pass @@ -34088,7 +34092,7 @@ Args: Returns: typing.Any - + """ pass @@ -34104,7 +34108,7 @@ Args: Returns: None - + """ pass @@ -34120,7 +34124,7 @@ Args: Returns: None - + """ pass @@ -34138,7 +34142,7 @@ Args: Returns: typing.Tuple[typing.Any, PyIShellItemResources] - + """ pass @@ -34156,13 +34160,13 @@ Args: Returns: - typing.Tuple[typing.Any, PyIShellItem]:Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT from the operation and the new shell item, which may be None + typing.Tuple[typing.Any, PyIShellItem]:Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT from the operation and the new shell item, which may be None -when the code in one of the informational COPYENGINE_S_* values. See MSDN for descriptions +when the code in one of the informational COPYENGINE_S_* values. See MSDN for descriptions of expected actions for specific error codes. - + """ pass @@ -34180,7 +34184,7 @@ Args: Returns: typing.Tuple[typing.Any, PyIShellItem] - + """ pass @@ -34198,7 +34202,7 @@ Returns: typing.Any:Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT of the operation - + """ pass @@ -34216,7 +34220,7 @@ Args: Returns: typing.Tuple[typing.Any, PyIShellItem] - + """ pass @@ -34235,7 +34239,7 @@ Args: Returns: typing.Tuple[typing.Any, PyIShellItem] - + """ pass @@ -34251,14 +34255,14 @@ Args: Returns: PyIShellItem - + """ pass def GetDefaultDestinationName(self,Source:'PyIShellItem',ParentDest:'PyIShellItem') -> 'typing.Any': """ - Determines the name of an item as it would appear in a + Determines the name of an item as it would appear in a given folder @@ -34270,14 +34274,14 @@ Args: Returns: typing.Any - + """ pass def EnterFolder(self,ChildFolderDest:'PyIShellItem') -> 'typing.Any': """ - Informs the copy engine that a folder will be the target of a file + Informs the copy engine that a folder will be the target of a file operation @@ -34288,14 +34292,14 @@ Args: Returns: typing.Any - + """ pass def LeaveFolder(self,ChildFolderDest:'PyIShellItem') -> 'typing.Any': """ - Informs the copy engine that the operation on a destination folder is + Informs the copy engine that the operation on a destination folder is finished @@ -34306,7 +34310,7 @@ Args: Returns: typing.Any - + """ pass @@ -34330,7 +34334,7 @@ Args: Returns: typing.Any - + """ pass @@ -34346,7 +34350,7 @@ Args: Returns: typing.Any - + """ pass @@ -34360,7 +34364,7 @@ class PyITypeInfo(object): def GetContainingTypeLib(self,) -> 'typing.Tuple[PyITypeLib, typing.Any]': """ - Retrieves the containing type library and the index of + Retrieves the containing type library and the index of the type description within that type library. @@ -34371,14 +34375,14 @@ Args: Returns: typing.Tuple[PyITypeLib, typing.Any] - + """ pass def GetDocumentation(self,memberId:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': """ - Retrieves the documentation string, + Retrieves the documentation string, the complete Help file name and path, and the context ID for the Help topic for a specified type description. @@ -34389,7 +34393,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass @@ -34405,14 +34409,14 @@ Args: Returns: FUNCDESC - + """ pass def GetImplTypeFlags(self,index:'typing.Any') -> 'typing.Any': """ - Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or + Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or base interface in a type description. @@ -34423,14 +34427,14 @@ Args: Returns: typing.Any - + """ pass def GetIDsOfNames(self,) -> 'typing.Any': """ - Maps between member names and member IDs, and parameter names and parameter + Maps between member names and member IDs, and parameter names and parameter IDs. @@ -34441,14 +34445,14 @@ Args: Returns: typing.Any - + """ pass def GetNames(self,memberId:'typing.Any') -> 'typing.Any': """ - Retrieves the variable with the specified member ID (or the name of + Retrieves the variable with the specified member ID (or the name of the property or method and its parameters) that correspond to the specified function ID. @@ -34459,7 +34463,7 @@ Args: Returns: typing.Any - + """ pass @@ -34475,14 +34479,14 @@ Args: Returns: TYPEATTR - + """ pass def GetRefTypeInfo(self,hRefType:'typing.Any') -> 'PyITypeInfo': """ - If a type description references other type descriptions, it + If a type description references other type descriptions, it retrieves the referenced type descriptions. @@ -34493,7 +34497,7 @@ Args: Returns: PyITypeInfo - + """ pass @@ -34509,7 +34513,7 @@ Args: Returns: typing.Any - + """ pass @@ -34525,7 +34529,7 @@ Args: Returns: VARDESC - + """ pass @@ -34541,7 +34545,7 @@ Args: Returns: PyITypeComp - + """ pass @@ -34565,7 +34569,7 @@ Returns: typing.Any:The index of the type description within the libraryReturn ValueThe return type is a tuple of (name of item, documentation string, help context integer, help file name) - + """ pass @@ -34581,7 +34585,7 @@ Args: Returns: TLIBATTR - + """ pass @@ -34597,7 +34601,7 @@ Args: Returns: PyITypeComp - + """ pass @@ -34613,7 +34617,7 @@ Args: Returns: PyITypeInfo - + """ pass @@ -34629,7 +34633,7 @@ Args: Returns: typing.Any - + """ pass @@ -34645,7 +34649,7 @@ Args: Returns: PyITypeInfo - + """ pass @@ -34661,7 +34665,7 @@ Args: Returns: typing.Any - + """ pass @@ -34684,7 +34688,7 @@ Args: Returns: typing.Any - + """ pass @@ -34701,7 +34705,7 @@ Args: Returns: None - + """ pass @@ -34719,7 +34723,7 @@ Args: Returns: typing.Any - + """ pass @@ -34742,41 +34746,41 @@ Args: Returns: - PyIUnknown:If provided and not None, will return an + PyIUnknown:If provided and not None, will return an -interface for the specified IID if (and only if) a native interface can not be supported. +interface for the specified IID if (and only if) a native interface can not be supported. If the interface specified by iid is natively supported, this option is ignored. Comments -The useIID parameter is a very dangerous option, and should only +The useIID parameter is a very dangerous option, and should only -be used when you are sure you need it! +be used when you are sure you need it! -By specifying this parameter, you are telling the COM framework that regardless +By specifying this parameter, you are telling the COM framework that regardless -of the true type of the result (as specified by iid), a Python wrapper +of the true type of the result (as specified by iid), a Python wrapper -of type useIID will be created. If iid does not derive from useIID, +of type useIID will be created. If iid does not derive from useIID, -then it is almost certain that using the object will cause an Access Violation. +then it is almost certain that using the object will cause an Access Violation. -For example, this option can be used to obtain a PyIUnknown object if +For example, this option can be used to obtain a PyIUnknown object if -pythoncom does not natively support the interface. +pythoncom does not natively support the interface. -Another example might be to return an unsupported persistence interface as a +Another example might be to return an unsupported persistence interface as a -PyIPersist instance. +PyIPersist instance. -For backwards compatibility: the integer 0 implies None, and the +For backwards compatibility: the integer 0 implies None, and the integer 1 implies IID_IUnknown. -Return ValueThe result is always an object derived from PyIUnknown. +Return ValueThe result is always an object derived from PyIUnknown. Any error (including E_NOINTERFACE) will generate a com_error exception. - + """ pass @@ -34807,7 +34811,7 @@ Args: Returns: None - + """ pass @@ -34826,7 +34830,7 @@ Args: Returns: None - + """ pass @@ -34844,7 +34848,7 @@ Args: Returns: None - + """ pass @@ -34860,7 +34864,7 @@ Args: Returns: None - + """ pass @@ -34878,7 +34882,7 @@ Args: Returns: None - + """ pass @@ -34894,7 +34898,7 @@ Args: Returns: None - + """ pass @@ -34919,7 +34923,7 @@ Args: Returns: None - + """ pass @@ -34969,7 +34973,7 @@ Args: Returns: typing.Any - + """ pass @@ -34985,7 +34989,7 @@ Args: Returns: typing.Any - + """ pass @@ -35002,7 +35006,7 @@ Args: Returns: PyPROPVARIANT - + """ pass @@ -35071,7 +35075,7 @@ class PySPropTagArray(object): class PySPropValue(object): - """A MAPI property value. Property values can either be passed from + """A MAPI property value. Property values can either be passed from python into MAPI functions, or returned from MAPI functions to Python.""" @@ -35165,7 +35169,7 @@ Args: Returns: None - + """ pass @@ -35185,7 +35189,7 @@ class RTF_WCSINFO(object): class SHFILEINFO(object): - """A tuple representing a SHFILEINFO structure + """A tuple representing a SHFILEINFO structure Represented as a tuple of (hIcon, iIcon, dwAttributes, displayName, typeName)""" @@ -35339,9 +35343,9 @@ class TYPEATTR(object): class TYPEDESC(object): - """A typedesc is a complicated, recursive object, + """A typedesc is a complicated, recursive object, -It may be either a simple Python type, or a tuple of (indirectType, object), where object +It may be either a simple Python type, or a tuple of (indirectType, object), where object may be a simple Python type, or a tuple of etc ...""" @@ -35446,7 +35450,7 @@ Args: Returns: None - + """ pass @@ -35462,7 +35466,7 @@ Args: Returns: typing.Any - + """ pass @@ -35487,7 +35491,7 @@ Args: Returns: None - + """ pass @@ -35503,7 +35507,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -35519,7 +35523,7 @@ Args: Returns: typing.Any - + """ pass @@ -35536,14 +35540,14 @@ Args: Returns: None - + """ pass def LoadBitmapFile(self,fileObject:'typing.Any') -> 'None': """ - Loads a bitmap (.BMP) format + Loads a bitmap (.BMP) format from a file object. @@ -35554,14 +35558,14 @@ Args: Returns: None - + """ pass def LoadPPMFile(self,fileObject:'typing.Any',cols:'typing.Any',rows:'typing.Any') -> 'None': """ - Loads a bitmap in Portable Pix Map (PPM) format + Loads a bitmap in Portable Pix Map (PPM) format from a file object. @@ -35574,7 +35578,7 @@ Args: Returns: None - + """ pass @@ -35592,7 +35596,7 @@ Args: Returns: None - + """ pass @@ -35610,21 +35614,21 @@ Returns: typing.Any:PyCBitmap.GetInfo dict = GetInfo()Returns the BITMAP structure info -Return ValueA dictionary of integers, keyed by the following strings: +Return ValueA dictionary of integers, keyed by the following strings: -bmType +bmType -bmWidth +bmWidth -bmHeight +bmHeight -bmWidthBytes +bmWidthBytes -bmPlanes +bmPlanes bmBitsPixel - + """ pass @@ -35640,7 +35644,7 @@ Args: Returns: typing.Union[str, typing.Any] - + """ pass @@ -35657,7 +35661,7 @@ Args: Returns: typing.Any - + """ pass @@ -35680,7 +35684,7 @@ Args: Returns: None - + """ pass @@ -35696,7 +35700,7 @@ Args: Returns: typing.Any - + """ pass @@ -35723,7 +35727,7 @@ Args: Returns: None - + """ pass @@ -35739,7 +35743,7 @@ Args: Returns: typing.Any - + """ pass @@ -35755,7 +35759,7 @@ Args: Returns: typing.Any - + """ pass @@ -35771,7 +35775,7 @@ Args: Returns: typing.Any - + """ pass @@ -35787,7 +35791,7 @@ Args: Returns: None - + """ pass @@ -35803,7 +35807,7 @@ Args: Returns: typing.Any - + """ pass @@ -35819,7 +35823,7 @@ Args: Returns: typing.Any - + """ pass @@ -35835,7 +35839,7 @@ Args: Returns: typing.Any - + """ pass @@ -35852,7 +35856,7 @@ Args: Returns: typing.Any - + """ pass @@ -35875,7 +35879,7 @@ Args: Returns: None - + """ pass @@ -35891,7 +35895,7 @@ Args: Returns: None - + """ pass @@ -35909,36 +35913,36 @@ Returns: typing.Any:The ID of the command to be handled, or zero to handle all command messages.Comments -obHandler will be called as the application receives command notification messages with the specified ID. +obHandler will be called as the application receives command notification messages with the specified ID. -Command notification messages are usually sent in response to menu or toolbar commands. +Command notification messages are usually sent in response to menu or toolbar commands. -When updating a user interface element, Pythonwin will first check if a +When updating a user interface element, Pythonwin will first check if a -handler has been installed via PyCCmdTarget::HookCommandUpdate. If so, this alone +handler has been installed via PyCCmdTarget::HookCommandUpdate. If so, this alone -determines the state of the interface object. If no Update handler exists, +determines the state of the interface object. If no Update handler exists, -PythonWin will automatically enable a menu/toolbar item if a command handler exists +PythonWin will automatically enable a menu/toolbar item if a command handler exists -The handler will be called with 2 arguments +The handler will be called with 2 arguments -* The command id being handled. +* The command id being handled. -* The command notification code. +* The command notification code. -If the handler returns TRUE, then the command will be passed on to the +If the handler returns TRUE, then the command will be passed on to the -default handler, otherwise the message will be consumed. +default handler, otherwise the message will be consumed. -This method is best suited to handling messages from user interface +This method is best suited to handling messages from user interface -elements, such as menus, toolbars, etc. To handle notification messages from a control, +elements, such as menus, toolbars, etc. To handle notification messages from a control, you should use PyCCmdTarget::HookNotify Return ValueThe return value is the previous handler, or None. - + """ pass @@ -35956,18 +35960,18 @@ Returns: typing.Any:The ID of the command to be handled.Comments -The handler object passed will be called as +The handler object passed will be called as -the application updates user interface elements +the application updates user interface elements -with the specified ID. +with the specified ID. -See PyCCmdTarget::HookCommand for a description +See PyCCmdTarget::HookCommand for a description of the rules used to determine command routing and updating. Return ValueThe return value is the previous handler, or None. - + """ pass @@ -35987,7 +35991,7 @@ Returns: object = HookOleEvent()Hook an OLE Event. Return ValueThe return value is the previous handler, or None. - + """ pass @@ -36005,41 +36009,41 @@ Returns: typing.Any:The ID of the command to be handled, or zero to handle all command messages.Comments -obHandler will be called as the application receives control notification messages. +obHandler will be called as the application receives control notification messages. -These may also be handled via PyCCmdTarget::HookCommand, but this method is specific +These may also be handled via PyCCmdTarget::HookCommand, but this method is specific to control notifications, and therefore provides more information. -The handler will be called with 2 arguments +The handler will be called with 2 arguments -A tuple describing standard notification information. +A tuple describing standard notification information. -A tuple describing extra notification params, or an integer containing the address of the first byte of the +A tuple describing extra notification params, or an integer containing the address of the first byte of the -extended information. If the handler returns TRUE, then the command will be passed on to the default handler, +extended information. If the handler returns TRUE, then the command will be passed on to the default handler, otherwise the message will be consumed. -Certain notification codes are recognised internally, and these are converted to a Python tuple. +Certain notification codes are recognised internally, and these are converted to a Python tuple. -If the extra information is not recognised, the address is passed. These addresses could be +If the extra information is not recognised, the address is passed. These addresses could be -extracted using win32ui::GetBytes and the struct module, or using +extracted using win32ui::GetBytes and the struct module, or using -Sam Rushing's calldll/dynwin module. (It would be possible to extend Pythonwin so a program +Sam Rushing's calldll/dynwin module. (It would be possible to extend Pythonwin so a program can install certain knowledge about handlers, but this has not been implemented.) Return ValueThe return value is the previous handler, or None. - + """ pass def RestoreWaitCursor(self,) -> 'None': """ - Restores the appropriate hourglass cursor after the system cursor has + Restores the appropriate hourglass cursor after the system cursor has changed. @@ -36050,7 +36054,7 @@ Args: Returns: None - + """ pass @@ -36097,7 +36101,7 @@ Args: Returns: None - + """ pass @@ -36113,7 +36117,7 @@ Args: Returns: None - + """ pass @@ -36129,7 +36133,7 @@ Args: Returns: None - + """ pass @@ -36145,14 +36149,14 @@ Args: Returns: None - + """ pass def ContinueRouting(self,) -> 'None': """ - Tells the command-routing mechanism to continue routing the current message down + Tells the command-routing mechanism to continue routing the current message down the chain of handlers. @@ -36163,7 +36167,7 @@ Args: Returns: None - + """ pass @@ -36186,7 +36190,7 @@ Args: Returns: typing.Any - + """ pass @@ -36202,7 +36206,7 @@ Args: Returns: typing.Any - + """ pass @@ -36218,7 +36222,7 @@ Args: Returns: typing.Any - + """ pass @@ -36234,7 +36238,7 @@ Args: Returns: None - + """ pass @@ -36250,7 +36254,7 @@ Args: Returns: None - + """ pass @@ -36266,7 +36270,7 @@ Args: Returns: typing.Tuple[typing.Any, ...] - + """ pass @@ -36291,7 +36295,7 @@ Returns: typing.Any:CComboBox::AddString Return ValueThe zero based index of the new string. - + """ pass @@ -36309,7 +36313,7 @@ Returns: typing.Any:CComboBox::DeleteString Return ValueThe count of the items remaining in the list. - + """ pass @@ -36328,7 +36332,7 @@ Returns: typing.Any:CComboBox::Dir Return ValueThe index of the last file name added to the list. - + """ pass @@ -36346,7 +36350,7 @@ Returns: typing.Any:CListBox::GetCount Return ValueReturns the number of items currently in the combobox. - + """ pass @@ -36362,7 +36366,7 @@ Args: Returns: typing.Any - + """ pass @@ -36378,15 +36382,15 @@ Args: Returns: typing.Any:CComboBox::GetEditSel -Return ValueA 32-bit value that contains the starting position in the low-order word and +Return ValueA 32-bit value that contains the starting position in the low-order word and -the position of the first nonselected character after the end of +the position of the first nonselected character after the end of -the selection in the high-order word. If this function is used on a combo box +the selection in the high-order word. If this function is used on a combo box without an edit control, an exception is raised. - + """ pass @@ -36404,7 +36408,7 @@ Returns: typing.Any:CComboBox::GetExtendedUI Return ValueNonzero if the combo box has the extended user interface; otherwise 0. - + """ pass @@ -36420,7 +36424,7 @@ Args: Returns: typing.Any - + """ pass @@ -36436,7 +36440,7 @@ Args: Returns: typing.Any - + """ pass @@ -36451,11 +36455,11 @@ Args: Returns: - str:The index of the item to return the string for.Return ValueThe requested string. If index does + str:The index of the item to return the string for.Return ValueThe requested string. If index does not specify a valid index, no exception is raised. - + """ pass @@ -36471,7 +36475,7 @@ Args: Returns: typing.Any - + """ pass @@ -36490,7 +36494,7 @@ Returns: typing.Any:CComboBox::InsertString Return ValueThe zero based index of the new string added. - + """ pass @@ -36506,7 +36510,7 @@ Args: Returns: typing.Any - + """ pass @@ -36522,7 +36526,7 @@ Args: Returns: None - + """ pass @@ -36541,7 +36545,7 @@ Returns: None:CComboBoxBox::SelectString Return ValueThe return value is always None - an exception is raised if the string can not be located. - + """ pass @@ -36557,7 +36561,7 @@ Args: Returns: None - + """ pass @@ -36574,11 +36578,11 @@ Args: Returns: None:PyCComboBox::SetEditSel -Return ValueThe return value is always None - an exception is raised if the combo is a dropdown style, or does not +Return ValueThe return value is always None - an exception is raised if the combo is a dropdown style, or does not have an edit control. - + """ pass @@ -36594,7 +36598,7 @@ Args: Returns: None - + """ pass @@ -36611,7 +36615,7 @@ Args: Returns: typing.Any - + """ pass @@ -36628,7 +36632,7 @@ Args: Returns: typing.Any - + """ pass @@ -36644,7 +36648,7 @@ Args: Returns: None - + """ pass @@ -36702,7 +36706,7 @@ class PyCControlBar(object): def CalcDynamicLayout(self,length:'typing.Any',dwMode:'typing.Any') -> 'typing.Any': """ - The framework calls this member function to calculate the dimensions of + The framework calls this member function to calculate the dimensions of a dynamic toolbar. @@ -36714,7 +36718,7 @@ Args: Returns: typing.Any - + """ pass @@ -36731,14 +36735,14 @@ Args: Returns: typing.Any - + """ pass def EnableDocking(self,style:'typing.Any') -> 'None': """ - pecifies whether the control bar supports docking and the sides of its parent + pecifies whether the control bar supports docking and the sides of its parent window. @@ -36749,7 +36753,7 @@ Args: Returns: None - + """ pass @@ -36765,7 +36769,7 @@ Args: Returns: None - + """ pass @@ -36781,7 +36785,7 @@ Args: Returns: typing.Any - + """ pass @@ -36797,7 +36801,7 @@ Args: Returns: typing.Any - + """ pass @@ -36813,14 +36817,14 @@ Args: Returns: PyCFrameWnd - + """ pass def IsFloating(self,) -> 'typing.Any': """ - Returns a nonzero value if the control bar in question is a floating control + Returns a nonzero value if the control bar in question is a floating control bar. @@ -36831,7 +36835,7 @@ Args: Returns: typing.Any - + """ pass @@ -36847,7 +36851,7 @@ Args: Returns: None - + """ pass @@ -36867,12 +36871,12 @@ Returns: int = ShowWindow()Shows the toolbar, and recalculates the button layout. Comments -This method is provided for convenience. For further details, see +This method is provided for convenience. For further details, see PyCWnd::ShowWindow and PyCFrameWnd::RecalcLayout Return ValueThe return value is that returned from PyCWnd::ShowWindow - + """ pass @@ -36896,7 +36900,7 @@ Args: Returns: None - + """ pass @@ -36919,7 +36923,7 @@ Args: Returns: None - + """ pass @@ -36939,7 +36943,7 @@ Returns: None:CDC::Arc Return ValueAlways none. If the function fails, an exception is raised. - + """ pass @@ -36955,7 +36959,7 @@ Args: Returns: None - + """ pass @@ -36975,7 +36979,7 @@ Args: Returns: None - + """ pass @@ -36995,7 +36999,7 @@ Returns: None:CDC::Chord Return ValueAlways none. If the function fails, an exception is raised. - + """ pass @@ -37011,7 +37015,7 @@ Args: Returns: None - + """ pass @@ -37027,7 +37031,7 @@ Args: Returns: None - + """ pass @@ -37043,7 +37047,7 @@ Args: Returns: None - + """ pass @@ -37064,7 +37068,7 @@ Returns: To Do Should really handle list of (x,y) points Return ValueThe converted coordinates. - + """ pass @@ -37082,14 +37086,14 @@ Args: Returns: None - + """ pass def DrawFocusRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': """ - Draws a rectangle in the style used to + Draws a rectangle in the style used to indicate the rectangle has focus @@ -37100,7 +37104,7 @@ Args: Returns: None - + """ pass @@ -37118,7 +37122,7 @@ Args: Returns: None - + """ pass @@ -37135,7 +37139,7 @@ Args: Returns: None - + """ pass @@ -37152,9 +37156,9 @@ Args: Returns: - typing.Tuple[typing.Any, typing.Any, typing.Any]:Specifies one or more bit-or'd format values, such as + typing.Tuple[typing.Any, typing.Any, typing.Any]:Specifies one or more bit-or'd format values, such as -DT_BOTTOM, DT_CENTERDT_RIGHT, DT_VCENTER. For a complete list, see +DT_BOTTOM, DT_CENTERDT_RIGHT, DT_VCENTER. For a complete list, see the Microsoft Win32 API documentation.ExampleExample import win32ui<nl> @@ -37198,15 +37202,15 @@ Return ValueHeight of text in pixels -The return value is the height of the text, in logical units. +The return value is the height of the text, in logical units. -If DT_VCENTER or DT_BOTTOM is specified, the return value is the +If DT_VCENTER or DT_BOTTOM is specified, the return value is the -offset from rect.top to the bottom of the drawn text. +offset from rect.top to the bottom of the drawn text. If the function fails, the return value is zero (no Python exception is thrown) - + """ pass @@ -37224,7 +37228,7 @@ Returns: None:CDC::Ellipse Return ValueAlways none. If the function fails, an exception is raised. - + """ pass @@ -37240,7 +37244,7 @@ Args: Returns: None - + """ pass @@ -37256,14 +37260,14 @@ Args: Returns: None - + """ pass def EndPath(self,) -> 'None': """ - Closes a path bracket and selects the path defined by the bracket into the specified device + Closes a path bracket and selects the path defined by the bracket into the specified device context @@ -37274,7 +37278,7 @@ Args: Returns: None - + """ pass @@ -37297,14 +37301,14 @@ Returns: None:CDC::ExtTextOut Return ValueAlways none. If the function fails, an exception is raised. - + """ pass def FillPath(self,) -> 'None': """ - Closes any open figures in the current path and fills the path's interior by using the + Closes any open figures in the current path and fills the path's interior by using the current brush and polygon-filling mode. After its interior is filled, the path is discarded from the device context. @@ -37315,7 +37319,7 @@ Args: Returns: None - + """ pass @@ -37332,7 +37336,7 @@ Args: Returns: None - + """ pass @@ -37349,7 +37353,7 @@ Args: Returns: None - + """ pass @@ -37366,14 +37370,14 @@ Args: Returns: None - + """ pass def GetBrushOrg(self,) -> 'typing.Tuple[typing.Any, typing.Any]': """ - Retrieves the origin (in device units) of the brush currently selected for the + Retrieves the origin (in device units) of the brush currently selected for the device context. @@ -37384,14 +37388,14 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass def GetClipBox(self,) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': """ - Retrieves the dimensions of the smallest bounding rectangle + Retrieves the dimensions of the smallest bounding rectangle around the current clipping boundary. @@ -37404,7 +37408,7 @@ Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]:CDC::GetClipBox Return ValueA tuple of integers specifying the rectangle. - + """ pass @@ -37420,7 +37424,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -37438,7 +37442,7 @@ Returns: typing.Any:CDC::GetDeviceCaps Return ValueThe value of the requested capability - + """ pass @@ -37454,7 +37458,7 @@ Args: Returns: typing.Any - + """ pass @@ -37470,7 +37474,7 @@ Args: Returns: typing.Any - + """ pass @@ -37486,7 +37490,7 @@ Args: Returns: typing.Any - + """ pass @@ -37502,7 +37506,7 @@ Args: Returns: typing.Any - + """ pass @@ -37519,7 +37523,7 @@ Args: Returns: None - + """ pass @@ -37535,14 +37539,14 @@ Args: Returns: typing.Any - + """ pass def GetTextExtent(self,text:'str') -> 'typing.Tuple[typing.Any, typing.Any]': """ - Calculates the width and height of a line of text using the current font to + Calculates the width and height of a line of text using the current font to determine the dimensions. @@ -37555,7 +37559,7 @@ Returns: typing.Tuple[typing.Any, typing.Any]:CFC::GetTextExtent Return ValueA tuple of integers with the size of the string, in logical units. - + """ pass @@ -37572,7 +37576,7 @@ Returns: typing.Tuple[typing.Any, typing.Any]:The text to calculate for.Return ValueA tuple of integers with the size of the string, in logical units. - + """ pass @@ -37588,7 +37592,7 @@ Args: Returns: str - + """ pass @@ -37604,49 +37608,49 @@ Args: Returns: typing.Any:CDC::GetTextMetrics -Return ValueA dictionary of integers, keyed by the following strings: +Return ValueA dictionary of integers, keyed by the following strings: -tmHeight +tmHeight -tmAscent +tmAscent -tmDescent +tmDescent -tmInternalLeading +tmInternalLeading -tmExternalLeading +tmExternalLeading -tmAveCharWidth +tmAveCharWidth -tmMaxCharWidth +tmMaxCharWidth -tmWeight +tmWeight -tmItalic +tmItalic -tmUnderlined +tmUnderlined -tmStruckOut +tmStruckOut -tmFirstChar +tmFirstChar -tmLastChar +tmLastChar -tmDefaultChar +tmDefaultChar -tmBreakChar +tmBreakChar -tmPitchAndFamily +tmPitchAndFamily -tmCharSet +tmCharSet -tmOverhang +tmOverhang -tmDigitizedAspectX +tmDigitizedAspectX tmDigitizedAspectY - + """ pass @@ -37662,7 +37666,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -37678,7 +37682,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -37694,14 +37698,14 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass def GetWindowOrg(self,) -> 'typing.Tuple[typing.Any, typing.Any]': """ - Retrieves the x- and y-coordinates of the origin of the window associated with the + Retrieves the x- and y-coordinates of the origin of the window associated with the device context. @@ -37712,14 +37716,14 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass def IntersectClipRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': """ - Creates a new clipping region by forming the intersection of the current region + Creates a new clipping region by forming the intersection of the current region and the rectangle specified @@ -37732,7 +37736,7 @@ Returns: None:CDC::IntersectClipRect Return Valueregion type as integer - + """ pass @@ -37748,7 +37752,7 @@ Args: Returns: typing.Any - + """ pass @@ -37766,7 +37770,7 @@ Args: Returns: None - + """ pass @@ -37786,7 +37790,7 @@ Returns: typing.Tuple[typing.Any, typing.Any]:CDC::LPtoDP Return ValueThe converted coordinates. - + """ pass @@ -37806,14 +37810,14 @@ Returns: typing.Tuple[typing.Any, typing.Any]:CDC::MoveTo Return ValueThe previous position. - + """ pass def OffsetWindowOrg(self,arg:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any]': """ - Modifies the coordinates of the window origin relative to the coordinates of the + Modifies the coordinates of the window origin relative to the coordinates of the current window origin. @@ -37825,14 +37829,14 @@ Returns: typing.Tuple[typing.Any, typing.Any]:The new origin offset.Return ValueThe previous origin as a tuple (x,y) - + """ pass def OffsetViewportOrg(self,arg:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any]': """ - Modifies the coordinates of the viewport origin relative to the coordinates of + Modifies the coordinates of the viewport origin relative to the coordinates of the current viewport origin @@ -37844,7 +37848,7 @@ Returns: typing.Tuple[typing.Any, typing.Any]:The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) - + """ pass @@ -37862,7 +37866,7 @@ Args: Returns: None - + """ pass @@ -37885,7 +37889,7 @@ Args: Returns: None - + """ pass @@ -37901,7 +37905,7 @@ Args: Returns: None - + """ pass @@ -37917,7 +37921,7 @@ Args: Returns: None - + """ pass @@ -37933,7 +37937,7 @@ Args: Returns: None - + """ pass @@ -37951,22 +37955,22 @@ Returns: typing.Any:PyCDC.RealizePalette int = RealizePalette()Maps palette entries in the current logical palette to the system palette. -Return ValueIndicates how many entries in the logical palette were mapped to different entries +Return ValueIndicates how many entries in the logical palette were mapped to different entries -in the system palette. This represents the number of entries that this function +in the system palette. This represents the number of entries that this function -remapped to accommodate changes in the system palette since the logical palette +remapped to accommodate changes in the system palette since the logical palette was last realized. - + """ pass def Rectangle(self,) -> 'typing.Any': """ - Draws a rectangle using the current pen. The interior of the rectangle is filled using + Draws a rectangle using the current pen. The interior of the rectangle is filled using the current brush. @@ -37977,14 +37981,14 @@ Args: Returns: typing.Any - + """ pass def RectVisible(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'typing.Any': """ - Determines whether any part of the given rectangle lies within the clipping region of + Determines whether any part of the given rectangle lies within the clipping region of the display context. @@ -37997,7 +38001,7 @@ Returns: typing.Any:CDC::RectVisible Return ValueNon zero if any part of the rectangle lies within the clipping region, else zero. - + """ pass @@ -38013,7 +38017,7 @@ Args: Returns: None - + """ pass @@ -38029,11 +38033,11 @@ Args: Returns: typing.Any:CDC::SaveDC -Return ValueAn integer identifying the context, which can be used by PyCDC::RestoreDC. +Return ValueAn integer identifying the context, which can be used by PyCDC::RestoreDC. An exception is raised if this function fails. - + """ pass @@ -38049,7 +38053,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -38065,7 +38069,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -38085,7 +38089,7 @@ Returns: obRgn = SelectClipRgn()Selects the given region as the current clipping region for the device context Return ValueThe return value specifies the region's complexity (integer) - + """ pass @@ -38103,7 +38107,7 @@ Returns: typing.Any:CDC::SelectObject Return ValueThe previously selected object. This will be the same type as the object parameter. - + """ pass @@ -38121,7 +38125,7 @@ Returns: typing.Any:CDC::SetBkColor Return ValueThe return value is the previous background color. - + """ pass @@ -38139,14 +38143,14 @@ Returns: typing.Any:CDC::SetBkMode Return ValueThe return value is the previous background mode. - + """ pass def SetBrushOrg(self,point:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any]': """ - Specifies the origin that GDI will assign to the next brush that the + Specifies the origin that GDI will assign to the next brush that the application selects into the device context. @@ -38159,7 +38163,7 @@ Returns: typing.Tuple[typing.Any, typing.Any]:CDC::SetBrushOrg Return ValueThe previous origin in device units. - + """ pass @@ -38175,7 +38179,7 @@ Args: Returns: typing.Any - + """ pass @@ -38193,7 +38197,7 @@ Returns: typing.Any:CDC::SetMapMode Return ValueThe previous mapping mode. - + """ pass @@ -38211,7 +38215,7 @@ Args: Returns: None - + """ pass @@ -38233,7 +38237,7 @@ Return ValueThe previous PolyFillMode as integer The previous PolyFillMode. - + """ pass @@ -38249,7 +38253,7 @@ Args: Returns: typing.Any - + """ pass @@ -38267,7 +38271,7 @@ Returns: typing.Any:CDC::SetTextAlign Return ValueThe old alignment flags. - + """ pass @@ -38285,7 +38289,7 @@ Returns: typing.Any:CDC::SetTextColor Return ValueThe return value is the previous text color. - + """ pass @@ -38303,7 +38307,7 @@ Returns: typing.Tuple[typing.Any, typing.Any]:CDC::SetWindowExt Return ValueThe previous extents of the window (in logical units). - + """ pass @@ -38319,7 +38323,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -38337,7 +38341,7 @@ Returns: typing.Tuple[typing.Any, typing.Any]:CDC::SetViewportExt Return ValueThe previous extents of the viewport (in logical units). - + """ pass @@ -38353,16 +38357,16 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass def SetWorldTransform(self,) -> 'typing.Any': """ - sets a two-dimensional linear transformation between world space and page space + sets a two-dimensional linear transformation between world space and page space -for the specified device context. This transformation can be used to scale, rotate, shear, or translate graphics +for the specified device context. This transformation can be used to scale, rotate, shear, or translate graphics output. @@ -38373,7 +38377,7 @@ Args: Returns: typing.Any - + """ pass @@ -38390,7 +38394,7 @@ Args: Returns: None - + """ pass @@ -38406,7 +38410,7 @@ Args: Returns: None - + """ pass @@ -38427,14 +38431,14 @@ Args: Returns: None - + """ pass def StrokeAndFillPath(self,) -> 'None': """ - Closes any open figures in a path, strokes the outline of the path by using the + Closes any open figures in a path, strokes the outline of the path by using the current pen, and fills its interior by using the current brush. The device context must contain a closed path. @@ -38445,7 +38449,7 @@ Args: Returns: None - + """ pass @@ -38461,7 +38465,7 @@ Args: Returns: None - + """ pass @@ -38481,7 +38485,7 @@ Returns: None:CDC::TextOut Return ValueAlways none. If the function fails, an exception is raised. - + """ pass @@ -38504,7 +38508,7 @@ Args: Returns: None - + """ pass @@ -38522,7 +38526,7 @@ Returns: typing.Any:CDialog::DoModal Return ValueThe return value from the dialog. This is the value passed to PyCDialog::EndDialog. - + """ pass @@ -38538,7 +38542,7 @@ Args: Returns: None - + """ pass @@ -38554,14 +38558,14 @@ Args: Returns: None - + """ pass def MapDialogRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': """ - Converts the dialog-box units of a rectangle to screen + Converts the dialog-box units of a rectangle to screen units. @@ -38572,7 +38576,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass @@ -38588,7 +38592,7 @@ Args: Returns: None - + """ pass @@ -38604,7 +38608,7 @@ Args: Returns: None - + """ pass @@ -38620,7 +38624,7 @@ Args: Returns: typing.Any - + """ pass @@ -38646,7 +38650,7 @@ Args: Returns: None - + """ pass @@ -38669,7 +38673,7 @@ Args: Returns: PyCDocument - + """ pass @@ -38685,7 +38689,7 @@ Args: Returns: PyCDocument - + """ pass @@ -38701,7 +38705,7 @@ Args: Returns: str - + """ pass @@ -38717,7 +38721,7 @@ Args: Returns: typing.Any - + """ pass @@ -38733,7 +38737,7 @@ Args: Returns: None - + """ pass @@ -38749,7 +38753,7 @@ Args: Returns: PyCMenu - + """ pass @@ -38767,7 +38771,7 @@ Args: Returns: None - + """ pass @@ -38783,7 +38787,7 @@ Args: Returns: None - + """ pass @@ -38799,7 +38803,7 @@ Args: Returns: None - + """ pass @@ -38816,7 +38820,7 @@ Args: Returns: None - + """ pass @@ -38953,7 +38957,7 @@ Args: Returns: typing.Any - + """ pass @@ -38969,7 +38973,7 @@ Args: Returns: typing.Any - + """ pass @@ -38985,7 +38989,7 @@ Args: Returns: typing.Any - + """ pass @@ -39002,7 +39006,7 @@ Args: Returns: typing.Any - + """ pass @@ -39018,7 +39022,7 @@ Args: Returns: typing.Any - + """ pass @@ -39032,9 +39036,9 @@ class PyCDocument(object): def DeleteContents(self,) -> 'None': """ - Call the MFC DeleteContents method. + Call the MFC DeleteContents method. -This routine is provided so a document object which overrides this method +This routine is provided so a document object which overrides this method can call the original MFC version if required. @@ -39045,7 +39049,7 @@ Args: Returns: None - + """ pass @@ -39062,16 +39066,16 @@ Args: Returns: None - + """ pass def DoFileSave(self,) -> 'None': """ - Checks the file attributes. + Checks the file attributes. -If the file is read only, a new name is prompted, else the +If the file is read only, a new name is prompted, else the file is saved (by calling DoSave) @@ -39082,7 +39086,7 @@ Args: Returns: None - + """ pass @@ -39098,7 +39102,7 @@ Args: Returns: PyCDocTemplate - + """ pass @@ -39114,7 +39118,7 @@ Args: Returns: typing.List[typing.Any] - + """ pass @@ -39130,14 +39134,14 @@ Args: Returns: PyCView - + """ pass def GetPathName(self,) -> 'str': """ - Returns the full path name of the current document. + Returns the full path name of the current document. The string will be empty if no path name has been set. @@ -39148,14 +39152,14 @@ Args: Returns: str - + """ pass def GetTitle(self,) -> 'str': """ - Returns the title of the current document. + Returns the title of the current document. This will often be the file name portion of the path name. @@ -39166,7 +39170,7 @@ Args: Returns: str - + """ pass @@ -39182,7 +39186,7 @@ Args: Returns: typing.Any - + """ pass @@ -39198,16 +39202,16 @@ Args: Returns: None - + """ pass def OnCloseDocument(self,) -> 'None': """ - Call the MFC OnCloseDocument handler. + Call the MFC OnCloseDocument handler. -This routine is provided so a document object which overrides this method +This routine is provided so a document object which overrides this method can call the original MFC version if required. @@ -39218,16 +39222,16 @@ Args: Returns: None - + """ pass def OnNewDocument(self,) -> 'None': """ - Call the MFC OnNewDocument handler. + Call the MFC OnNewDocument handler. -This routine is provided so a document object which overrides this method +This routine is provided so a document object which overrides this method can call the original MFC version if required. @@ -39238,16 +39242,16 @@ Args: Returns: None - + """ pass def OnOpenDocument(self,pathName:'str') -> 'None': """ - Call the MFC OnOpenDocument handler. + Call the MFC OnOpenDocument handler. -This routine is provided so a document object which overrides this method +This routine is provided so a document object which overrides this method can call the original MFC version if required. @@ -39258,16 +39262,16 @@ Args: Returns: None - + """ pass def OnSaveDocument(self,pathName:'str') -> 'None': """ - Call the MFC OnSaveDocument handler. + Call the MFC OnSaveDocument handler. -This routine is provided so a document object which overrides this method +This routine is provided so a document object which overrides this method can call the original MFC version if required. @@ -39278,7 +39282,7 @@ Args: Returns: None - + """ pass @@ -39294,7 +39298,7 @@ Args: Returns: None - + """ pass @@ -39312,7 +39316,7 @@ Returns: typing.Any:CDocument::SaveModified Return ValueNonzero if it is safe to continue and close the document; 0 if the document should not be closed. - + """ pass @@ -39328,14 +39332,14 @@ Args: Returns: None - + """ pass def SetTitle(self,title:'str') -> 'None': """ - Set the title of the document (ie, the name + Set the title of the document (ie, the name to appear in the window caption for the document. @@ -39346,7 +39350,7 @@ Args: Returns: None - + """ pass @@ -39363,7 +39367,7 @@ Args: Returns: None - + """ pass @@ -39389,7 +39393,7 @@ Args: Returns: None - + """ pass @@ -39405,7 +39409,7 @@ Args: Returns: typing.Any - + """ pass @@ -39421,7 +39425,7 @@ Args: Returns: None - + """ pass @@ -39437,7 +39441,7 @@ Args: Returns: None - + """ pass @@ -39455,7 +39459,7 @@ Returns: typing.Any:CEdit::FmtLines Return ValueNonzero if any formatting occurs; otherwise 0. - + """ pass @@ -39473,7 +39477,7 @@ Returns: typing.Any:CEdit::GetFirstVisibleLine Return ValueThe zero-based index of the topmost visible line. For single-line edit controls, the return value is 0. - + """ pass @@ -39489,11 +39493,11 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any]:CEdit::GetSel -Return ValueThe return tuple is (the first character in the current selection, first nonselected character past the +Return ValueThe return tuple is (the first character in the current selection, first nonselected character past the end of the current selection) - + """ pass @@ -39509,7 +39513,7 @@ Args: Returns: typing.Any - + """ pass @@ -39527,7 +39531,7 @@ Returns: typing.Any:CEdit::GetLineCount Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - + """ pass @@ -39543,7 +39547,7 @@ Args: Returns: None - + """ pass @@ -39559,13 +39563,13 @@ Args: Returns: typing.Any:CEdit::LineFromChar -Return ValueThe zero-based line number of the line containing the character index specified by charNo. +Return ValueThe zero-based line number of the line containing the character index specified by charNo. -If charNo is -1, the number of the line that contains the first character of the selection is returned. +If charNo is -1, the number of the line that contains the first character of the selection is returned. If there is no selection, the current line number is returned. - + """ pass @@ -39581,13 +39585,13 @@ Args: Returns: typing.Any:CEdit::LineIndex -Return ValueThe character index of the line specified in lineNo, or -1 if +Return ValueThe character index of the line specified in lineNo, or -1 if -the specified line number is greater then the number of lines in +the specified line number is greater then the number of lines in the edit control. - + """ pass @@ -39604,7 +39608,7 @@ Args: Returns: typing.Any - + """ pass @@ -39620,7 +39624,7 @@ Args: Returns: None - + """ pass @@ -39636,7 +39640,7 @@ Args: Returns: None - + """ pass @@ -39652,7 +39656,7 @@ Args: Returns: None - + """ pass @@ -39672,7 +39676,7 @@ Args: Returns: None - + """ pass @@ -39695,7 +39699,7 @@ Args: Returns: typing.Any - + """ pass @@ -39711,7 +39715,7 @@ Args: Returns: None - + """ pass @@ -39727,7 +39731,7 @@ Args: Returns: None - + """ pass @@ -39743,7 +39747,7 @@ Args: Returns: typing.Any - + """ pass @@ -39759,7 +39763,7 @@ Args: Returns: typing.Any - + """ pass @@ -39775,7 +39779,7 @@ Args: Returns: None - + """ pass @@ -39792,7 +39796,7 @@ Args: Returns: None - + """ pass @@ -39815,7 +39819,7 @@ Args: Returns: str - + """ pass @@ -39831,7 +39835,7 @@ Args: Returns: str - + """ pass @@ -39847,7 +39851,7 @@ Args: Returns: str - + """ pass @@ -39863,7 +39867,7 @@ Args: Returns: str - + """ pass @@ -39879,7 +39883,7 @@ Args: Returns: str - + """ pass @@ -39895,7 +39899,7 @@ Args: Returns: typing.Any - + """ pass @@ -39911,7 +39915,7 @@ Args: Returns: None - + """ pass @@ -39927,7 +39931,7 @@ Args: Returns: None - + """ pass @@ -39950,7 +39954,7 @@ Args: Returns: typing.Any - + """ pass @@ -39973,7 +39977,7 @@ Args: Returns: typing.Any - + """ pass @@ -39989,7 +39993,7 @@ Args: Returns: typing.Any - + """ pass @@ -40005,7 +40009,7 @@ Args: Returns: typing.Any - + """ pass @@ -40021,7 +40025,7 @@ Args: Returns: typing.Any - + """ pass @@ -40037,7 +40041,7 @@ Args: Returns: str - + """ pass @@ -40053,7 +40057,7 @@ Args: Returns: str - + """ pass @@ -40069,7 +40073,7 @@ Args: Returns: typing.Any - + """ pass @@ -40085,7 +40089,7 @@ Args: Returns: typing.Any - + """ pass @@ -40101,7 +40105,7 @@ Args: Returns: typing.Any - + """ pass @@ -40117,7 +40121,7 @@ Args: Returns: typing.Any - + """ pass @@ -40133,7 +40137,7 @@ Args: Returns: typing.Any - + """ pass @@ -40149,7 +40153,7 @@ Args: Returns: typing.Any - + """ pass @@ -40173,7 +40177,7 @@ Args: Returns: None - + """ pass @@ -40196,7 +40200,7 @@ Args: Returns: None - + """ pass @@ -40219,7 +40223,7 @@ Args: Returns: typing.Any - + """ pass @@ -40235,7 +40239,7 @@ Args: Returns: None - + """ pass @@ -40253,7 +40257,7 @@ Args: Returns: None - + """ pass @@ -40269,7 +40273,7 @@ Args: Returns: None - + """ pass @@ -40287,7 +40291,7 @@ Args: Returns: None - + """ pass @@ -40303,7 +40307,7 @@ Args: Returns: PyCDocument - + """ pass @@ -40319,7 +40323,7 @@ Args: Returns: PyCControlBar - + """ pass @@ -40335,7 +40339,7 @@ Args: Returns: str - + """ pass @@ -40351,7 +40355,7 @@ Args: Returns: PyCWnd - + """ pass @@ -40367,7 +40371,7 @@ Args: Returns: typing.Any - + """ pass @@ -40383,7 +40387,7 @@ Args: Returns: typing.Any - + """ pass @@ -40399,7 +40403,7 @@ Args: Returns: None - + """ pass @@ -40418,7 +40422,7 @@ Args: Returns: None - + """ pass @@ -40434,7 +40438,7 @@ Args: Returns: None - + """ pass @@ -40450,7 +40454,7 @@ Args: Returns: typing.Any - + """ pass @@ -40466,7 +40470,7 @@ Args: Returns: None - + """ pass @@ -40484,14 +40488,14 @@ Args: Returns: None - + """ pass def RecalcLayout(self,bNotify:'typing.Any'=1) -> 'None': """ - Called by the framework when the standard control bars are toggled on or off or + Called by the framework when the standard control bars are toggled on or off or when the frame window is resized. @@ -40502,7 +40506,7 @@ Args: Returns: None - + """ pass @@ -40518,7 +40522,7 @@ Args: Returns: PyCView - + """ pass @@ -40534,7 +40538,7 @@ Args: Returns: typing.Any - + """ pass @@ -40550,7 +40554,7 @@ Args: Returns: typing.Any - + """ pass @@ -40567,7 +40571,7 @@ Args: Returns: None - + """ pass @@ -40602,7 +40606,7 @@ Returns: typing.Any:Handle of an icon to add. Return ValueZero-based index of the first new image. - + """ pass @@ -40618,7 +40622,7 @@ Args: Returns: None - + """ pass @@ -40634,7 +40638,7 @@ Args: Returns: None - + """ pass @@ -40650,7 +40654,7 @@ Args: Returns: typing.Any - + """ pass @@ -40666,7 +40670,7 @@ Args: Returns: typing.Any - + """ pass @@ -40682,7 +40686,7 @@ Args: Returns: typing.Any - + """ pass @@ -40699,7 +40703,7 @@ Returns: typing.Any:Index of image.Return ValueThe return info is a tuple describing an IMAGELIST structure. - + """ pass @@ -40715,7 +40719,7 @@ Args: Returns: None - + """ pass @@ -40740,7 +40744,7 @@ Returns: typing.Any:CListBox::AddString Return ValueThe zero based index of the new string. - + """ pass @@ -40758,7 +40762,7 @@ Returns: typing.Any:CListBox::DeleteString Return ValueThe count of the items remaining in the list. - + """ pass @@ -40777,7 +40781,7 @@ Returns: typing.Any:CListBox::Dir Return ValueThe index of the last file name added to the list. - + """ pass @@ -40795,13 +40799,13 @@ Returns: typing.Any:PyCListBox.GetCaretIndex int = GetCaretIndex()Returns the index of the item which has focus. -Return ValueThe zero-based index of the item that has the focus rectangle in a list box. +Return ValueThe zero-based index of the item that has the focus rectangle in a list box. -If the list box is a single-selection list box, the return value is the index of the item that is selected, if +If the list box is a single-selection list box, the return value is the index of the item that is selected, if any. - + """ pass @@ -40819,7 +40823,7 @@ Returns: typing.Any:CListBox::GetCount Return ValueReturns the number of items currently in the listbox. - + """ pass @@ -40835,7 +40839,7 @@ Args: Returns: typing.Any - + """ pass @@ -40851,7 +40855,7 @@ Args: Returns: typing.Any - + """ pass @@ -40867,7 +40871,7 @@ Args: Returns: typing.Any - + """ pass @@ -40885,7 +40889,7 @@ Returns: typing.Any:CListBox::GetSel Return ValueA +ve number if the item is selected, else zero. - + """ pass @@ -40901,14 +40905,14 @@ Args: Returns: typing.Any - + """ pass def GetSelItems(self,) -> 'typing.Any': """ - Returns a list of the indexes of the currently selected items in a multiple + Returns a list of the indexes of the currently selected items in a multiple selection listbox. @@ -40919,14 +40923,14 @@ Args: Returns: typing.Any - + """ pass def GetSelTextItems(self,) -> 'typing.Any': """ - Returns a list of the strings of the currently selected items in a multiple + Returns a list of the strings of the currently selected items in a multiple selection listbox. @@ -40937,7 +40941,7 @@ Args: Returns: typing.Any - + """ pass @@ -40955,7 +40959,7 @@ Returns: typing.Any:CListBox::GetTopIndex Return ValueThe zero based index of the top most visible item. - + """ pass @@ -40971,7 +40975,7 @@ Args: Returns: str - + """ pass @@ -40987,7 +40991,7 @@ Args: Returns: typing.Any - + """ pass @@ -41006,7 +41010,7 @@ Returns: typing.Any:CListBox::InsertString Return ValueThe zero based index of the new string added. - + """ pass @@ -41022,7 +41026,7 @@ Args: Returns: None - + """ pass @@ -41039,7 +41043,7 @@ Args: Returns: None - + """ pass @@ -41058,7 +41062,7 @@ Returns: None:CListBox::SelectString Return ValueThe return value is always None - an exception is raised if the string can not be located. - + """ pass @@ -41076,7 +41080,7 @@ Args: Returns: None - + """ pass @@ -41092,7 +41096,7 @@ Args: Returns: None - + """ pass @@ -41109,7 +41113,7 @@ Args: Returns: typing.Any - + """ pass @@ -41126,7 +41130,7 @@ Args: Returns: typing.Any - + """ pass @@ -41143,7 +41147,7 @@ Args: Returns: None - + """ pass @@ -41160,7 +41164,7 @@ Args: Returns: None - + """ pass @@ -41176,7 +41180,7 @@ Args: Returns: None - + """ pass @@ -41199,7 +41203,7 @@ Args: Returns: None - + """ pass @@ -41218,7 +41222,7 @@ Args: Returns: None - + """ pass @@ -41234,7 +41238,7 @@ Args: Returns: None - + """ pass @@ -41250,7 +41254,7 @@ Args: Returns: None - + """ pass @@ -41266,7 +41270,7 @@ Args: Returns: typing.Any - + """ pass @@ -41282,7 +41286,7 @@ Args: Returns: None - + """ pass @@ -41298,7 +41302,7 @@ Args: Returns: typing.Any - + """ pass @@ -41314,7 +41318,7 @@ Args: Returns: None - + """ pass @@ -41331,7 +41335,7 @@ Args: Returns: LV_ITEM - + """ pass @@ -41347,7 +41351,7 @@ Args: Returns: typing.Any - + """ pass @@ -41364,14 +41368,14 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass def GetEditControl(self,) -> 'PyCEdit': """ - Retrieves the handle of the edit control used to edit the specified + Retrieves the handle of the edit control used to edit the specified list view item. @@ -41382,7 +41386,7 @@ Args: Returns: PyCEdit - + """ pass @@ -41398,7 +41402,7 @@ Args: Returns: PyCEdit - + """ pass @@ -41415,14 +41419,14 @@ Args: Returns: typing.Any - + """ pass def CreateDragImage(self,item:'typing.Any') -> 'typing.Tuple[PyCImageList, typing.Any, typing.Any]': """ - Creates a dragging bitmap for the specified list view + Creates a dragging bitmap for the specified list view item. @@ -41433,7 +41437,7 @@ Args: Returns: typing.Tuple[PyCImageList, typing.Any, typing.Any] - + """ pass @@ -41449,14 +41453,14 @@ Args: Returns: PyCImageList - + """ pass def GetNextItem(self,item:'typing.Any',flags:'typing.Any') -> 'typing.Any': """ - Searches for a list view item with specified properties and with specified + Searches for a list view item with specified properties and with specified relationship to a given item. @@ -41467,21 +41471,21 @@ Args: Returns: - typing.Any:Geometric relation of the requested item to the specified item, + typing.Any:Geometric relation of the requested item to the specified item, -and the state of the requested item. The geometric relation can be one of these values: +and the state of the requested item. The geometric relation can be one of these values: -LVNI_ABOVELVNI_ALLLVNI_BELOWLVNI_TOLEFTLVNI_TORIGHT +LVNI_ABOVELVNI_ALLLVNI_BELOWLVNI_TOLEFTLVNI_TORIGHT -The state can be zero, or it can be one or more of these values: +The state can be zero, or it can be one or more of these values: -LVNI_DROPHILITEDLVNI_FOCUSEDLVNI_HIDDENLVNI_MARKEDLVNI_SELECTED +LVNI_DROPHILITEDLVNI_FOCUSEDLVNI_HIDDENLVNI_MARKEDLVNI_SELECTED -If an item does not have all of the specified state flags set, the search continues with the +If an item does not have all of the specified state flags set, the search continues with the next item.Return ValueReturns an integer index, or raises a win32ui.error exception if not item can be found. - + """ pass @@ -41498,7 +41502,7 @@ Args: Returns: typing.Any - + """ pass @@ -41519,7 +41523,7 @@ Args: Returns: typing.Any - + """ pass @@ -41536,7 +41540,7 @@ Args: Returns: typing.Any - + """ pass @@ -41552,7 +41556,7 @@ Args: Returns: LV_COLUMN - + """ pass @@ -41568,7 +41572,7 @@ Args: Returns: typing.Any - + """ pass @@ -41584,7 +41588,7 @@ Args: Returns: None - + """ pass @@ -41600,14 +41604,14 @@ Args: Returns: typing.Any - + """ pass def GetCountPerPage(self,) -> 'typing.Any': """ - Calculates the number of items that can fit vertically in a list view + Calculates the number of items that can fit vertically in a list view control. @@ -41618,7 +41622,7 @@ Args: Returns: typing.Any - + """ pass @@ -41634,7 +41638,7 @@ Args: Returns: typing.Any - + """ pass @@ -41650,7 +41654,7 @@ Args: Returns: typing.Any - + """ pass @@ -41668,7 +41672,7 @@ Args: Returns: typing.Any - + """ pass @@ -41685,7 +41689,7 @@ Args: Returns: typing.Any - + """ pass @@ -41702,7 +41706,7 @@ Args: Returns: typing.Any - + """ pass @@ -41718,7 +41722,7 @@ Args: Returns: typing.Any - + """ pass @@ -41734,7 +41738,7 @@ Args: Returns: None - + """ pass @@ -41752,7 +41756,7 @@ Args: Returns: typing.Any - + """ pass @@ -41769,7 +41773,7 @@ Args: Returns: typing.Any - + """ pass @@ -41786,7 +41790,7 @@ Args: Returns: typing.Any - + """ pass @@ -41802,7 +41806,7 @@ Args: Returns: None - + """ pass @@ -41819,7 +41823,7 @@ Args: Returns: typing.Any - + """ pass @@ -41835,7 +41839,7 @@ Args: Returns: typing.Any - + """ pass @@ -41851,7 +41855,7 @@ Args: Returns: typing.Any - + """ pass @@ -41868,7 +41872,7 @@ Args: Returns: typing.Any - + """ pass @@ -41884,7 +41888,7 @@ Args: Returns: typing.Any - + """ pass @@ -41899,7 +41903,7 @@ Args: Returns: - typing.Tuple[typing.Any, typing.Any, typing.Any]:The point to test.Return ValueThe result is a tuple of (flags, item, subItem). + typing.Tuple[typing.Any, typing.Any, typing.Any]:The point to test.Return ValueThe result is a tuple of (flags, item, subItem). flags may be a combination of the following values: @@ -41914,7 +41918,7 @@ Description commctrl.LVHT_ABOVEThe position is above the control's client area. commctrl.LVHT_BELOWThe position is below the control's client area. -commctrl.LVHT_NOWHEREThe position is inside the list view control's client window, but it is not over a +commctrl.LVHT_NOWHEREThe position is inside the list view control's client window, but it is not over a list item. commctrl.LVHT_ONITEMICONThe position is over a list view item's icon. @@ -41923,7 +41927,7 @@ commctrl.LVHT_ONITEMSTATEICONThe position is over the state image of a list view commctrl.LVHT_TOLEFTThe position is to the left of the list view control's client area. commctrl.LVHT_TORIGHTThe position is to the right of the list view control's client area. - + """ pass @@ -41939,7 +41943,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -41962,7 +41966,7 @@ Args: Returns: typing.Any - + """ pass @@ -41978,7 +41982,7 @@ Args: Returns: PyCListCtrl - + """ pass @@ -41995,7 +41999,7 @@ Args: Returns: None - + """ pass @@ -42018,7 +42022,7 @@ Args: Returns: None - + """ pass @@ -42039,7 +42043,7 @@ Args: Returns: typing.Any - + """ pass @@ -42055,7 +42059,7 @@ Args: Returns: None - + """ pass @@ -42071,7 +42075,7 @@ Args: Returns: None - + """ pass @@ -42087,7 +42091,7 @@ Args: Returns: typing.Any - + """ pass @@ -42103,7 +42107,7 @@ Args: Returns: None - + """ pass @@ -42120,7 +42124,7 @@ Args: Returns: None - + """ pass @@ -42136,7 +42140,7 @@ Args: Returns: None - + """ pass @@ -42159,14 +42163,14 @@ Args: Returns: PyCMDIFrameWnd - + """ pass def MDIGetActive(self,) -> 'typing.Tuple[PyCMDIChildWnd, typing.Any]': """ - Retrieves the current active MDI child window, along + Retrieves the current active MDI child window, along with a flag indicating whether the child window is maximized. @@ -42177,7 +42181,7 @@ Args: Returns: typing.Tuple[PyCMDIChildWnd, typing.Any] - + """ pass @@ -42193,7 +42197,7 @@ Args: Returns: PyCMDIFrameWnd - + """ pass @@ -42209,7 +42213,7 @@ Args: Returns: None - + """ pass @@ -42225,7 +42229,7 @@ Args: Returns: typing.Any - + """ pass @@ -42241,7 +42245,7 @@ Args: Returns: None - + """ pass @@ -42258,7 +42262,7 @@ Args: Returns: None - + """ pass @@ -42274,7 +42278,7 @@ Args: Returns: typing.Any - + """ pass @@ -42290,7 +42294,7 @@ Args: Returns: None - + """ pass @@ -42304,7 +42308,7 @@ class PyCMenu(object): def AppendMenu(self,flags:'typing.Any',_id:'typing.Any'=0,value:'typing.Union[str, typing.Any]'=None) -> 'None': """ - Appends a new item to the end of a menu. Python can specify the state of the menu item + Appends a new item to the end of a menu. Python can specify the state of the menu item by setting values in nFlags. @@ -42317,7 +42321,7 @@ Args: Returns: None - + """ pass @@ -42334,7 +42338,7 @@ Args: Returns: str - + """ pass @@ -42351,7 +42355,7 @@ Args: Returns: typing.Any - + """ pass @@ -42367,7 +42371,7 @@ Args: Returns: typing.Any - + """ pass @@ -42387,7 +42391,7 @@ Returns: int = GetMenuItemCount()Determines the number of items in a menu. Return ValueThe number of items in the menu if the function is successful; otherwise -1. - + """ pass @@ -42403,7 +42407,7 @@ Args: Returns: typing.Any - + """ pass @@ -42420,7 +42424,7 @@ Args: Returns: str - + """ pass @@ -42436,7 +42440,7 @@ Args: Returns: PyCMenu - + """ pass @@ -42455,7 +42459,7 @@ Args: Returns: None - + """ pass @@ -42474,7 +42478,7 @@ Args: Returns: None - + """ pass @@ -42494,16 +42498,16 @@ Returns: None:The owner of the menu. Comments -The TrackPopupMenu function displays a floating pop-up menu at the +The TrackPopupMenu function displays a floating pop-up menu at the -specified location and tracks the selection of items on the pop-up menu. +specified location and tracks the selection of items on the pop-up menu. The floating pop-up menu can appear anywhere on the screen. -Return ValueIf the underlying MFC function fails, but TPM_RETURNCMD is set in the flags parameter, then None is +Return ValueIf the underlying MFC function fails, but TPM_RETURNCMD is set in the flags parameter, then None is returned instead of the normal exception. - + """ pass @@ -42526,7 +42530,7 @@ Args: Returns: None - + """ pass @@ -42542,7 +42546,7 @@ Args: Returns: None - + """ pass @@ -42558,14 +42562,14 @@ Args: Returns: None - + """ pass def Draw(self,) -> 'None': """ - Draws the OLE item into the specified bounding rectangle using the specified device + Draws the OLE item into the specified bounding rectangle using the specified device context. @@ -42576,7 +42580,7 @@ Args: Returns: None - + """ pass @@ -42592,7 +42596,7 @@ Args: Returns: PyCView - + """ pass @@ -42608,14 +42612,14 @@ Args: Returns: PyCDocument - + """ pass def GetInPlaceWindow(self,) -> 'PyCWnd': """ - Obtains the window in which the item has been opened for + Obtains the window in which the item has been opened for in-place editing. @@ -42626,7 +42630,7 @@ Args: Returns: PyCWnd - + """ pass @@ -42642,14 +42646,14 @@ Args: Returns: None - + """ pass def GetObject(self,) -> 'PyIUnknown': """ - Returns the COM object to the item. This is the m_lpObject + Returns the COM object to the item. This is the m_lpObject variable in MFC. @@ -42660,7 +42664,7 @@ Args: Returns: PyIUnknown - + """ pass @@ -42676,7 +42680,7 @@ Args: Returns: None - + """ pass @@ -42692,7 +42696,7 @@ Args: Returns: None - + """ pass @@ -42708,7 +42712,7 @@ Args: Returns: None - + """ pass @@ -42728,7 +42732,7 @@ Returns: int = OnChangeItemPosition()Calls the underlying MFC method. Return ValueThe result is a BOOL indicating if the function succeeded. No exception is thrown. - + """ pass @@ -42744,7 +42748,7 @@ Args: Returns: typing.Any - + """ pass @@ -42760,7 +42764,7 @@ Args: Returns: None - + """ pass @@ -42776,7 +42780,7 @@ Args: Returns: None - + """ pass @@ -42797,7 +42801,7 @@ class PyCOleDocument(object): def EnableCompoundFile(self,bEnable:'typing.Any'=1) -> 'None': """ - Call this function if you want to store the document using the + Call this function if you want to store the document using the compound-file format. @@ -42808,7 +42812,7 @@ Args: Returns: None - + """ pass @@ -42824,14 +42828,14 @@ Args: Returns: typing.Any - + """ pass def GetNextItem(self,pos:'typing.Any') -> 'typing.Tuple[typing.Any, PyCOleClientItem]': """ - Call this function repeatedly to access each of + Call this function repeatedly to access each of the items in your document. @@ -42842,14 +42846,14 @@ Args: Returns: typing.Tuple[typing.Any, PyCOleClientItem] - + """ pass def GetInPlaceActiveItem(self,wnd:'PyCWnd') -> 'PyCOleClientItem': """ - Obtains the OLE item that is currently activated + Obtains the OLE item that is currently activated in place in the frame window containing the view identified by obWnd. @@ -42860,7 +42864,7 @@ Args: Returns: PyCOleClientItem - + """ pass @@ -42883,7 +42887,7 @@ Args: Returns: typing.Any - + """ pass @@ -42899,7 +42903,7 @@ Args: Returns: typing.Any - + """ pass @@ -42915,7 +42919,7 @@ Args: Returns: typing.Any - + """ pass @@ -42945,14 +42949,14 @@ Args: Returns: None - + """ pass def GetDwFlags(self,) -> 'None': """ - A flags specifying DocObject printing operations. Valid only if data member + A flags specifying DocObject printing operations. Valid only if data member m_bDocObject is TRUE. @@ -42963,14 +42967,14 @@ Args: Returns: None - + """ pass def SetDwFlags(self,) -> 'None': """ - Set a flag specifying DocObject printing operations. Valid only if data member + Set a flag specifying DocObject printing operations. Valid only if data member m_bDocObject is TRUE. @@ -42981,14 +42985,14 @@ Args: Returns: None - + """ pass def GetDocOffsetPage(self,) -> 'None': """ - Get the number of pages preceding the first page of a particular DocObject + Get the number of pages preceding the first page of a particular DocObject in a combined DocObject print job. @@ -42999,14 +43003,14 @@ Args: Returns: None - + """ pass def SetDocOffsetPage(self,) -> 'None': """ - Set the number of pages preceding the first page of a particular DocObject + Set the number of pages preceding the first page of a particular DocObject in a combined DocObject print job. @@ -43017,14 +43021,14 @@ Args: Returns: None - + """ pass def SetPrintDialog(self,) -> 'None': """ - Set a pointer to the CPrintDialog object used to display the Print dialog box + Set a pointer to the CPrintDialog object used to display the Print dialog box for the print job. @@ -43035,7 +43039,7 @@ Args: Returns: None - + """ pass @@ -43051,14 +43055,14 @@ Args: Returns: None - + """ pass def SetDirect(self,) -> 'None': """ - Sets to TRUE if the Print dialog box will be bypassed for direct printing; FALSE + Sets to TRUE if the Print dialog box will be bypassed for direct printing; FALSE otherwise. @@ -43069,7 +43073,7 @@ Args: Returns: None - + """ pass @@ -43085,7 +43089,7 @@ Args: Returns: None - + """ pass @@ -43101,7 +43105,7 @@ Args: Returns: None - + """ pass @@ -43117,7 +43121,7 @@ Args: Returns: None - + """ pass @@ -43133,7 +43137,7 @@ Args: Returns: None - + """ pass @@ -43149,7 +43153,7 @@ Args: Returns: None - + """ pass @@ -43165,7 +43169,7 @@ Args: Returns: None - + """ pass @@ -43181,7 +43185,7 @@ Args: Returns: None - + """ pass @@ -43197,7 +43201,7 @@ Args: Returns: None - + """ pass @@ -43213,7 +43217,7 @@ Args: Returns: None - + """ pass @@ -43229,7 +43233,7 @@ Args: Returns: None - + """ pass @@ -43245,7 +43249,7 @@ Args: Returns: None - + """ pass @@ -43261,7 +43265,7 @@ Args: Returns: None - + """ pass @@ -43277,7 +43281,7 @@ Args: Returns: None - + """ pass @@ -43293,7 +43297,7 @@ Args: Returns: None - + """ pass @@ -43309,7 +43313,7 @@ Args: Returns: None - + """ pass @@ -43325,7 +43329,7 @@ Args: Returns: None - + """ pass @@ -43341,7 +43345,7 @@ Args: Returns: None - + """ pass @@ -43357,16 +43361,16 @@ Args: Returns: None - + """ pass def GetOffsetPage(self,) -> 'None': """ - Get the number of pages preceding the first page of a DocObject item being + Get the number of pages preceding the first page of a DocObject item being -printed in a combined DocObject print job. This currently does NOT work, as, if I include the symbol +printed in a combined DocObject print job. This currently does NOT work, as, if I include the symbol pInfo->GetOffsetPage(), the link fails to find its definition. Allways returns 0. @@ -43377,7 +43381,7 @@ Args: Returns: None - + """ pass @@ -43393,7 +43397,7 @@ Args: Returns: None - + """ pass @@ -43409,14 +43413,14 @@ Args: Returns: None - + """ pass def SetHDC(self,hdc:'typing.Any') -> 'None': """ - Sets the printer DC compatible with the users choices, call after the print dialog + Sets the printer DC compatible with the users choices, call after the print dialog DoModal finishes. @@ -43427,14 +43431,14 @@ Args: Returns: None - + """ pass def CreatePrinterDC(self,) -> 'None': """ - Handle to the newly created printer device context, call only after DoModal + Handle to the newly created printer device context, call only after DoModal finishes. @@ -43445,7 +43449,7 @@ Args: Returns: None - + """ pass @@ -43461,7 +43465,7 @@ Args: Returns: None - + """ pass @@ -43477,26 +43481,26 @@ Args: Returns: None - + """ pass def GetDefaults(self,) -> 'None': """ - Nonzero if the function was successful; otherwise 0. Call this function to + Nonzero if the function was successful; otherwise 0. Call this function to -retrieve the device defaults of the default printer without displaying a dialog box. The retrieved values are placed +retrieve the device defaults of the default printer without displaying a dialog box. The retrieved values are placed -in the m_pd structure. In some cases, a call to this function will call the constructor for CPrintDialog with +in the m_pd structure. In some cases, a call to this function will call the constructor for CPrintDialog with -bPrintSetupOnly set to FALSE. In these cases, a printer DC and hDevNames and hDevMode (two handles located in the +bPrintSetupOnly set to FALSE. In these cases, a printer DC and hDevNames and hDevMode (two handles located in the -m_pd data member) are automatically allocated. If the constructor for CPrintDialog was called with bPrintSetupOnly +m_pd data member) are automatically allocated. If the constructor for CPrintDialog was called with bPrintSetupOnly -set to FALSE, this function will not only return hDevNames and hDevMode (located in m_pd.hDevNames and m_pd.hDevMode) +set to FALSE, this function will not only return hDevNames and hDevMode (located in m_pd.hDevNames and m_pd.hDevMode) -to the caller, but will also return a printer DC in m_pd.hDC. It is the responsibility of the caller to delete the +to the caller, but will also return a printer DC in m_pd.hDC. It is the responsibility of the caller to delete the printer DC and call the WindowsGlobalFree function on the handles when you are finished with the CPrintDialog object. @@ -43507,14 +43511,14 @@ Args: Returns: None - + """ pass def FreeDefaults(self,) -> 'None': """ - After a call to GetDefaults, and you are through with the CPrintDialog object, + After a call to GetDefaults, and you are through with the CPrintDialog object, this call deletes the printer DC and calls GlobalFree function on the handles. @@ -43525,7 +43529,7 @@ Args: Returns: None - + """ pass @@ -43541,14 +43545,14 @@ Args: Returns: None - + """ pass def GetDriverName(self,) -> 'None': """ - The name of the currently selected printer device driver, call only after + The name of the currently selected printer device driver, call only after DoModal finishes. @@ -43559,7 +43563,7 @@ Args: Returns: None - + """ pass @@ -43575,7 +43579,7 @@ Args: Returns: None - + """ pass @@ -43591,14 +43595,14 @@ Args: Returns: None - + """ pass def GetPortName(self,) -> 'None': """ - The name of the currently selected printer port, call only after DoModal + The name of the currently selected printer port, call only after DoModal finishes. @@ -43609,18 +43613,18 @@ Args: Returns: None - + """ pass def GetPrinterDC(self,) -> 'None': """ - A handle to the printer device context if successful; otherwise NULL. If the + A handle to the printer device context if successful; otherwise NULL. If the -bPrintSetupOnly parameter of the CPrintDialog constructor was FALSE (indicating that the Print dialog box is +bPrintSetupOnly parameter of the CPrintDialog constructor was FALSE (indicating that the Print dialog box is -displayed), then GetPrinterDC returns a handle to the printer device context. You must call the WindowsDeleteDC +displayed), then GetPrinterDC returns a handle to the printer device context. You must call the WindowsDeleteDC function to delete the device context when you are done using it. @@ -43631,14 +43635,14 @@ Args: Returns: None - + """ pass def PrintAll(self,) -> 'None': """ - Nonzero if all pages in the document are to be printed; otherwise 0, call only after + Nonzero if all pages in the document are to be printed; otherwise 0, call only after DoModal finishes. @@ -43649,14 +43653,14 @@ Args: Returns: None - + """ pass def PrintCollate(self,) -> 'None': """ - Nonzero if the user selects the collate check box in the dialog box; otherwise + Nonzero if the user selects the collate check box in the dialog box; otherwise 0, call only after DoModal finishes. @@ -43667,14 +43671,14 @@ Args: Returns: None - + """ pass def PrintRange(self,) -> 'None': """ - Nonzero if only a range of pages in the document are to be printed; otherwise 0, + Nonzero if only a range of pages in the document are to be printed; otherwise 0, call only after DoModal finishes. @@ -43685,14 +43689,14 @@ Args: Returns: None - + """ pass def PrintSelection(self,) -> 'None': """ - Nonzero if only the selected items are to be printed; otherwise 0., call only + Nonzero if only the selected items are to be printed; otherwise 0., call only after DoModal finishes @@ -43703,16 +43707,16 @@ Args: Returns: None - + """ pass def GetHDC(self,) -> 'None': """ - Identifies a device context or an information context, depending on whether the Flags + Identifies a device context or an information context, depending on whether the Flags -member specifies the PD_RETURNDC or PC_RETURNIC flag. If neither flag is specified, the value of this member is +member specifies the PD_RETURNDC or PC_RETURNIC flag. If neither flag is specified, the value of this member is undefined. If both flags are specified, PD_RETURNDC has priority. @@ -43723,24 +43727,24 @@ Args: Returns: None - + """ pass def GetFlags(self,) -> 'None': """ - A set of bit flags that you can use to initialize the Print common dialog box. When + A set of bit flags that you can use to initialize the Print common dialog box. When -the dialog box returns, it sets these flags to indicate the user's input. This member can be a combination of the +the dialog box returns, it sets these flags to indicate the user's input. This member can be a combination of the -following flags: PD_ALLPAGES, PD_COLLATE, PD_DISABLEPRINTTOFILE, PD_ENABLEPRINTHOOK, PD_ENABLEPRINTTEMPLATE, +following flags: PD_ALLPAGES, PD_COLLATE, PD_DISABLEPRINTTOFILE, PD_ENABLEPRINTHOOK, PD_ENABLEPRINTTEMPLATE, -PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, +PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, -PD_HIDEPRINTTOFILE, PD_NONETWORKBUTTON, PD_NOPAGENUMS, PD_NOSELECTION, PD_NOWARNING, PD_PAGENUMS, PD_PRINTSETUP, +PD_HIDEPRINTTOFILE, PD_NONETWORKBUTTON, PD_NOPAGENUMS, PD_NOSELECTION, PD_NOWARNING, PD_PAGENUMS, PD_PRINTSETUP, -PD_PRINTTOFILE, PD_RETURNDC, PD_RETURNDEFAULT, PD_RETURNIC, PD_SELECTION, PD_SHOWHELP, PD_USEDEVMODECOPIES, +PD_PRINTTOFILE, PD_RETURNDC, PD_RETURNDEFAULT, PD_RETURNIC, PD_SELECTION, PD_SHOWHELP, PD_USEDEVMODECOPIES, PD_USEDEVMODECOPIESANDCOLLATE. @@ -43751,24 +43755,24 @@ Args: Returns: None - + """ pass def SetFlags(self,) -> 'None': """ - A set of bit flags that you can use to initialize the Print common dialog box. When + A set of bit flags that you can use to initialize the Print common dialog box. When -the dialog box returns, it sets these flags to indicate the user's input. This member can be a combination of the +the dialog box returns, it sets these flags to indicate the user's input. This member can be a combination of the -following flags: PD_ALLPAGES, PD_COLLATE, PD_DISABLEPRINTTOFILE, PD_ENABLEPRINTHOOK, PD_ENABLEPRINTTEMPLATE, +following flags: PD_ALLPAGES, PD_COLLATE, PD_DISABLEPRINTTOFILE, PD_ENABLEPRINTHOOK, PD_ENABLEPRINTTEMPLATE, -PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, +PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, -PD_HIDEPRINTTOFILE, PD_NONETWORKBUTTON, PD_NOPAGENUMS, PD_NOSELECTION, PD_NOWARNING, PD_PAGENUMS, PD_PRINTSETUP, +PD_HIDEPRINTTOFILE, PD_NONETWORKBUTTON, PD_NOPAGENUMS, PD_NOSELECTION, PD_NOWARNING, PD_PAGENUMS, PD_PRINTSETUP, -PD_PRINTTOFILE, PD_RETURNDC, PD_RETURNDEFAULT, PD_RETURNIC, PD_SELECTION, PD_SHOWHELP, PD_USEDEVMODECOPIES, +PD_PRINTTOFILE, PD_RETURNDC, PD_RETURNDEFAULT, PD_RETURNIC, PD_SELECTION, PD_SHOWHELP, PD_USEDEVMODECOPIES, PD_USEDEVMODECOPIESANDCOLLATE. @@ -43779,7 +43783,7 @@ Args: Returns: None - + """ pass @@ -43795,7 +43799,7 @@ Args: Returns: None - + """ pass @@ -43811,16 +43815,16 @@ Args: Returns: None - + """ pass def GetPRINTDLGMinPage(self,) -> 'None': """ - Get the minimum value for the page range specified in the From and To page + Get the minimum value for the page range specified in the From and To page -edit controls. If nMinPage equals nMaxPage, the Pages radio button and the starting and ending page edit controls are +edit controls. If nMinPage equals nMaxPage, the Pages radio button and the starting and ending page edit controls are disabled. @@ -43831,16 +43835,16 @@ Args: Returns: None - + """ pass def SetPRINTDLGMinPage(self,) -> 'None': """ - Set the minimum value for the page range specified in the From and To page + Set the minimum value for the page range specified in the From and To page -edit controls. If nMinPage equals nMaxPage, the Pages radio button and the starting and ending page edit controls are +edit controls. If nMinPage equals nMaxPage, the Pages radio button and the starting and ending page edit controls are disabled. @@ -43851,24 +43855,24 @@ Args: Returns: None - + """ pass def GetPRINTDLGCopies(self,) -> 'None': """ - Get the initial number of copies for the Copies edit control if hDevMode is + Get the initial number of copies for the Copies edit control if hDevMode is -NULL; otherwise, the dmCopies member of theDEVMODE structure contains the initial value. When PrintDlg returns, +NULL; otherwise, the dmCopies member of theDEVMODE structure contains the initial value. When PrintDlg returns, -nCopies contains the actual number of copies to print. This value depends on whether the application or the printer +nCopies contains the actual number of copies to print. This value depends on whether the application or the printer -driver is responsible for printing multiple copies. If the PD_USEDEVMODECOPIESANDCOLLATE flag is set in the Flags +driver is responsible for printing multiple copies. If the PD_USEDEVMODECOPIESANDCOLLATE flag is set in the Flags -member, nCopies is always 1 on return, and the printer driver is responsible for printing multiple copies. If the +member, nCopies is always 1 on return, and the printer driver is responsible for printing multiple copies. If the -flag is not set, the application is responsible for printing the number of copies specified by nCopies. For more +flag is not set, the application is responsible for printing the number of copies specified by nCopies. For more information, see the description of the PD_USEDEVMODECOPIESANDCOLLATE flag. @@ -43879,24 +43883,24 @@ Args: Returns: None - + """ pass def SetPRINTDLGCopies(self,) -> 'None': """ - Set the initial number of copies for the Copies edit control if hDevMode is + Set the initial number of copies for the Copies edit control if hDevMode is -NULL; otherwise, the dmCopies member of theDEVMODE structure contains the initial value. When PrintDlg returns, +NULL; otherwise, the dmCopies member of theDEVMODE structure contains the initial value. When PrintDlg returns, -nCopies contains the actual number of copies to print. This value depends on whether the application or the printer +nCopies contains the actual number of copies to print. This value depends on whether the application or the printer -driver is responsible for printing multiple copies. If the PD_USEDEVMODECOPIESANDCOLLATE flag is set in the Flags +driver is responsible for printing multiple copies. If the PD_USEDEVMODECOPIESANDCOLLATE flag is set in the Flags -member, nCopies is always 1 on return, and the printer driver is responsible for printing multiple copies. If the +member, nCopies is always 1 on return, and the printer driver is responsible for printing multiple copies. If the -flag is not set, the application is responsible for printing the number of copies specified by nCopies. For more +flag is not set, the application is responsible for printing the number of copies specified by nCopies. For more information, see the description of the PD_USEDEVMODECOPIESANDCOLLATE flag. @@ -43907,7 +43911,7 @@ Args: Returns: None - + """ pass @@ -43933,7 +43937,7 @@ Args: Returns: None - + """ pass @@ -43950,7 +43954,7 @@ Args: Returns: None - + """ pass @@ -43966,14 +43970,14 @@ Args: Returns: typing.Any - + """ pass def OffsetPos(self,nPos:'typing.Any'=1) -> 'typing.Any': """ - Advances the progress bar control's current position by the increment + Advances the progress bar control's current position by the increment specified @@ -43984,7 +43988,7 @@ Args: Returns: typing.Any - + """ pass @@ -44000,14 +44004,14 @@ Args: Returns: typing.Any - + """ pass def StepIt(self,) -> 'typing.Any': """ - Advances the current position for a progress bar control by the step increment. + Advances the current position for a progress bar control by the step increment. Returns previous position. @@ -44018,7 +44022,7 @@ Args: Returns: typing.Any - + """ pass @@ -44041,7 +44045,7 @@ Args: Returns: None - + """ pass @@ -44057,7 +44061,7 @@ Args: Returns: None - + """ pass @@ -44073,7 +44077,7 @@ Args: Returns: None - + """ pass @@ -44089,7 +44093,7 @@ Args: Returns: None - + """ pass @@ -44105,7 +44109,7 @@ Args: Returns: None - + """ pass @@ -44121,7 +44125,7 @@ Args: Returns: None - + """ pass @@ -44137,7 +44141,7 @@ Args: Returns: None - + """ pass @@ -44153,7 +44157,7 @@ Args: Returns: None - + """ pass @@ -44169,7 +44173,7 @@ Args: Returns: None - + """ pass @@ -44185,11 +44189,11 @@ Args: Returns: typing.Any:PyCPropertyPage.OnSetActive virtual method -Return ValueThe result is true if the page should be made active. +Return ValueThe result is true if the page should be made active. Typically this result should be passed to the original OnSetActive handler. - + """ pass @@ -44205,11 +44209,11 @@ Args: Returns: typing.Any:PyCPropertyPage.OnKillActive virtual method -Return ValueThe result is true if the page should be deselected. +Return ValueThe result is true if the page should be deselected. Typically this result should be passed to the original OnSetActive handler. - + """ pass @@ -44225,7 +44229,7 @@ Args: Returns: None - + """ pass @@ -44242,7 +44246,7 @@ Args: Returns: None - + """ pass @@ -44265,7 +44269,7 @@ Args: Returns: None - + """ pass @@ -44283,7 +44287,7 @@ Args: Returns: None - + """ pass @@ -44299,7 +44303,7 @@ Args: Returns: typing.Any - + """ pass @@ -44315,7 +44319,7 @@ Args: Returns: PyCPropertyPage - + """ pass @@ -44331,7 +44335,7 @@ Args: Returns: None - + """ pass @@ -44347,7 +44351,7 @@ Args: Returns: typing.Any - + """ pass @@ -44363,7 +44367,7 @@ Args: Returns: PyCPropertyPage - + """ pass @@ -44379,7 +44383,7 @@ Args: Returns: PyCPropertyPage - + """ pass @@ -44395,7 +44399,7 @@ Args: Returns: typing.Any - + """ pass @@ -44411,7 +44415,7 @@ Args: Returns: typing.Any - + """ pass @@ -44427,7 +44431,7 @@ Args: Returns: PyCTabCtrl - + """ pass @@ -44443,7 +44447,7 @@ Args: Returns: typing.Any - + """ pass @@ -44459,7 +44463,7 @@ Args: Returns: None - + """ pass @@ -44476,7 +44480,7 @@ Args: Returns: None - + """ pass @@ -44492,7 +44496,7 @@ Args: Returns: None - + """ pass @@ -44508,7 +44512,7 @@ Args: Returns: None - + """ pass @@ -44524,7 +44528,7 @@ Args: Returns: None - + """ pass @@ -44540,7 +44544,7 @@ Args: Returns: None - + """ pass @@ -44556,7 +44560,7 @@ Args: Returns: None - + """ pass @@ -44573,7 +44577,7 @@ Args: Returns: None - + """ pass @@ -44610,7 +44614,7 @@ Args: Returns: typing.Any - + """ pass @@ -44626,7 +44630,7 @@ Args: Returns: None - + """ pass @@ -44645,7 +44649,7 @@ Args: Returns: None - + """ pass @@ -44661,7 +44665,7 @@ Args: Returns: None - + """ pass @@ -44677,14 +44681,14 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any] - + """ pass def GetCharPos(self,charPos:'typing.Any') -> 'typing.Any': """ - Returns the location of the top-left corner of the character specified + Returns the location of the top-left corner of the character specified by charPos. @@ -44697,7 +44701,7 @@ Returns: typing.Any:The character positionReturn ValueThe return value is a win32ui::CHARFORMAT tuple - + """ pass @@ -44716,7 +44720,7 @@ Returns: Return ValueThe return value is a win32ui::CHARFORMAT tuple - + """ pass @@ -44732,7 +44736,7 @@ Args: Returns: typing.Any - + """ pass @@ -44748,7 +44752,7 @@ Args: Returns: typing.Any - + """ pass @@ -44766,7 +44770,7 @@ Returns: typing.Any:CRichEditCtrl::GetFirstVisibleLine Return ValueThe zero-based index of the topmost visible line. For single-line edit controls, the return value is 0. - + """ pass @@ -44785,7 +44789,7 @@ Returns: Return ValueThe return value is a win32ui::PARAFORMAT tuple - + """ pass @@ -44801,11 +44805,11 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any]:CRichEditCtrl::GetSel -Return ValueThe return tuple is (the first character in the current selection, first nonselected character past the +Return ValueThe return tuple is (the first character in the current selection, first nonselected character past the end of the current selection) - + """ pass @@ -44821,7 +44825,7 @@ Args: Returns: str - + """ pass @@ -44837,7 +44841,7 @@ Args: Returns: typing.Any - + """ pass @@ -44853,7 +44857,7 @@ Args: Returns: typing.Any - + """ pass @@ -44869,7 +44873,7 @@ Args: Returns: typing.Any - + """ pass @@ -44887,7 +44891,7 @@ Returns: typing.Any:CRichEditCtrl::GetLineCount Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - + """ pass @@ -44903,7 +44907,7 @@ Args: Returns: None - + """ pass @@ -44919,13 +44923,13 @@ Args: Returns: typing.Any:CRichEditCtrl::LineFromChar -Return ValueThe zero-based line number of the line containing the character index specified by charNo. +Return ValueThe zero-based line number of the line containing the character index specified by charNo. -If charNo is -1, the number of the line that contains the first character of the selection is returned. +If charNo is -1, the number of the line that contains the first character of the selection is returned. If there is no selection, the current line number is returned. - + """ pass @@ -44941,13 +44945,13 @@ Args: Returns: typing.Any:CRichEditCtrl::LineIndex -Return ValueThe character index of the line specified in lineNo, or -1 if +Return ValueThe character index of the line specified in lineNo, or -1 if -the specified line number is greater then the number of lines in +the specified line number is greater then the number of lines in the edit control. - + """ pass @@ -44964,7 +44968,7 @@ Args: Returns: typing.Any - + """ pass @@ -44980,7 +44984,7 @@ Args: Returns: None - + """ pass @@ -44996,7 +45000,7 @@ Args: Returns: None - + """ pass @@ -45015,7 +45019,7 @@ Returns: typing.Any:CRichEditCtrl::SetEventMask Return ValueThe return value is the previous background color. - + """ pass @@ -45031,7 +45035,7 @@ Args: Returns: None - + """ pass @@ -45049,7 +45053,7 @@ Returns: typing.Any:CRichEditCtrl::SetEventMask Return ValueThe return value is the previous event mask. - + """ pass @@ -45065,7 +45069,7 @@ Args: Returns: None - + """ pass @@ -45081,7 +45085,7 @@ Args: Returns: None - + """ pass @@ -45098,7 +45102,7 @@ Args: Returns: None - + """ pass @@ -45114,13 +45118,13 @@ Args: Returns: typing.Any:CRichEditCtrl::SetParaFormat -Return ValueThis function seems to return occasionally return failure, but +Return ValueThis function seems to return occasionally return failure, but -the formatting is applied. Therefore an exception is not raised on failure, +the formatting is applied. Therefore an exception is not raised on failure, but the BOOL return code is passed back. - + """ pass @@ -45136,7 +45140,7 @@ Args: Returns: None - + """ pass @@ -45154,7 +45158,7 @@ Args: Returns: None - + """ pass @@ -45170,7 +45174,7 @@ Args: Returns: None - + """ pass @@ -45187,7 +45191,7 @@ Args: Returns: None - + """ pass @@ -45206,7 +45210,7 @@ Returns: typing.Tuple[typing.Any, typing.Any]:CRichEditCtrl::StreamIn Return ValueThe return value is a tuple of (no bytes written, error code) - + """ pass @@ -45225,7 +45229,7 @@ Returns: typing.Tuple[typing.Any, typing.Any]:CRichEditCtrl::StreamOut Return ValueThe return value is a tuple of (no bytes written, error code) - + """ pass @@ -45239,9 +45243,9 @@ class PyCRichEditDoc(object): def OnCloseDocument(self,) -> 'None': """ - Call the MFC OnCloseDocument handler. + Call the MFC OnCloseDocument handler. -This routine is provided so a document object which overrides this method +This routine is provided so a document object which overrides this method can call the original MFC version if required. @@ -45252,7 +45256,7 @@ Args: Returns: None - + """ pass @@ -45275,7 +45279,7 @@ Args: Returns: PyCRichEditDoc - + """ pass @@ -45298,7 +45302,7 @@ Args: Returns: PyCRichEditCtrl - + """ pass @@ -45314,7 +45318,7 @@ Args: Returns: typing.Any - + """ pass @@ -45330,7 +45334,7 @@ Args: Returns: typing.Any - + """ pass @@ -45346,7 +45350,7 @@ Args: Returns: typing.Any - + """ pass @@ -45369,7 +45373,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -45385,7 +45389,7 @@ Args: Returns: PyCDC - + """ pass @@ -45401,7 +45405,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -45417,7 +45421,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -45434,7 +45438,7 @@ Args: Returns: None - + """ pass @@ -45450,7 +45454,7 @@ Args: Returns: typing.Any - + """ pass @@ -45466,7 +45470,7 @@ Args: Returns: None - + """ pass @@ -45482,7 +45486,7 @@ Args: Returns: None - + """ pass @@ -45501,7 +45505,7 @@ Args: Returns: None - + """ pass @@ -45517,7 +45521,7 @@ Args: Returns: None - + """ pass @@ -45543,7 +45547,7 @@ Args: Returns: None - + """ pass @@ -45559,7 +45563,7 @@ Args: Returns: typing.Any - + """ pass @@ -45575,7 +45579,7 @@ Args: Returns: typing.Any - + """ pass @@ -45591,7 +45595,7 @@ Args: Returns: typing.Any - + """ pass @@ -45607,7 +45611,7 @@ Args: Returns: typing.Any - + """ pass @@ -45623,7 +45627,7 @@ Args: Returns: typing.Any - + """ pass @@ -45639,7 +45643,7 @@ Args: Returns: typing.Any - + """ pass @@ -45655,7 +45659,7 @@ Args: Returns: typing.Any - + """ pass @@ -45673,7 +45677,7 @@ Args: Returns: typing.Any - + """ pass @@ -45689,7 +45693,7 @@ Args: Returns: typing.Any - + """ pass @@ -45706,7 +45710,7 @@ Args: Returns: typing.Any - + """ pass @@ -45722,7 +45726,7 @@ Args: Returns: typing.Any - + """ pass @@ -45738,7 +45742,7 @@ Args: Returns: typing.Any - + """ pass @@ -45754,7 +45758,7 @@ Args: Returns: typing.Any - + """ pass @@ -45770,7 +45774,7 @@ Args: Returns: typing.Any - + """ pass @@ -45786,7 +45790,7 @@ Args: Returns: typing.Any - + """ pass @@ -45802,7 +45806,7 @@ Args: Returns: typing.Any - + """ pass @@ -45818,7 +45822,7 @@ Args: Returns: typing.Any - + """ pass @@ -45834,7 +45838,7 @@ Args: Returns: typing.Any - + """ pass @@ -45850,7 +45854,7 @@ Args: Returns: typing.Any - + """ pass @@ -45866,7 +45870,7 @@ Args: Returns: typing.Any - + """ pass @@ -45882,7 +45886,7 @@ Args: Returns: typing.Any - + """ pass @@ -45898,7 +45902,7 @@ Args: Returns: typing.Any - + """ pass @@ -45914,7 +45918,7 @@ Args: Returns: typing.Any - + """ pass @@ -45937,7 +45941,7 @@ Args: Returns: typing.Any - + """ pass @@ -45954,7 +45958,7 @@ Returns: typing.Any:The new position.Return ValueThe result is the previous position. - + """ pass @@ -45970,7 +45974,7 @@ Args: Returns: typing.Any - + """ pass @@ -45986,7 +45990,7 @@ Args: Returns: typing.Any - + """ pass @@ -46010,7 +46014,7 @@ Args: Returns: PyCWnd - + """ pass @@ -46029,7 +46033,7 @@ Args: Returns: None - + """ pass @@ -46049,7 +46053,7 @@ Args: Returns: None - + """ pass @@ -46067,7 +46071,7 @@ Args: Returns: None - + """ pass @@ -46085,7 +46089,7 @@ Args: Returns: None - + """ pass @@ -46102,7 +46106,7 @@ Args: Returns: None - + """ pass @@ -46118,7 +46122,7 @@ Args: Returns: typing.Any - + """ pass @@ -46132,7 +46136,7 @@ class PyCStatusBar(object): def GetPaneInfo(self,index:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': """ - Returns the id, style, and width of the indicator pane at the + Returns the id, style, and width of the indicator pane at the location specified by index. @@ -46143,7 +46147,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any] - + """ pass @@ -46159,7 +46163,7 @@ Args: Returns: PyCStatusBarCtrl - + """ pass @@ -46175,7 +46179,7 @@ Args: Returns: None - + """ pass @@ -46194,7 +46198,7 @@ Args: Returns: None - + """ pass @@ -46220,14 +46224,14 @@ Args: Returns: None - + """ pass def GetBorders(self,) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': """ - Retrieve the status bar control's current widths of + Retrieve the status bar control's current widths of the horizontal and vertical borders and of the space between rectangles. @@ -46238,7 +46242,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any] - + """ pass @@ -46254,14 +46258,14 @@ Args: Returns: typing.Any - + """ pass def GetRect(self,nPane:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': """ - Retrieves the bounding rectangle of a part in a status + Retrieves the bounding rectangle of a part in a status bar control. @@ -46272,7 +46276,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass @@ -46288,14 +46292,14 @@ Args: Returns: typing.Any - + """ pass def GetTextAttr(self,nPane:'typing.Any') -> 'typing.Any': """ - Retrieve the attributes of the text in the given part of a status bar + Retrieve the attributes of the text in the given part of a status bar control. @@ -46306,7 +46310,7 @@ Args: Returns: typing.Any - + """ pass @@ -46322,7 +46326,7 @@ Args: Returns: typing.Any - + """ pass @@ -46338,14 +46342,14 @@ Args: Returns: None - + """ pass def SetParts(self,coord:'typing.Any') -> 'None': """ - Sets the number of parts in a status bar control and the coordinate of the right + Sets the number of parts in a status bar control and the coordinate of the right edge of each part. @@ -46356,7 +46360,7 @@ Args: Returns: None - + """ pass @@ -46374,14 +46378,14 @@ Args: Returns: None - + """ pass def SetTipText(self,nPane:'typing.Any',text:'str') -> 'None': """ - Sets the tooltip text for a pane in a status bar. The status bar must have + Sets the tooltip text for a pane in a status bar. The status bar must have been created with the afxres.SBT_TOOLTIPS control style to enable ToolTips. @@ -46393,7 +46397,7 @@ Args: Returns: None - + """ pass @@ -46420,7 +46424,7 @@ Returns: int = GetCurSel()Gets the current selection of a tab control. Return ValueThe zero-based index of the currently selected item, or -1 if no selection. - + """ pass @@ -46436,7 +46440,7 @@ Args: Returns: typing.Any - + """ pass @@ -46453,7 +46457,7 @@ Returns: typing.Any:The index of the tab to set current.Return ValueThe zero-based index of the previously selected item. - + """ pass @@ -46476,7 +46480,7 @@ Args: Returns: None - + """ pass @@ -46492,7 +46496,7 @@ Args: Returns: str - + """ pass @@ -46508,7 +46512,7 @@ Args: Returns: None - + """ pass @@ -46527,7 +46531,7 @@ Args: Returns: None - + """ pass @@ -46543,7 +46547,7 @@ Args: Returns: PyCToolBarCtrl - + """ pass @@ -46559,7 +46563,7 @@ Args: Returns: None - + """ pass @@ -46575,7 +46579,7 @@ Args: Returns: None - + """ pass @@ -46591,7 +46595,7 @@ Args: Returns: None - + """ pass @@ -46607,7 +46611,7 @@ Args: Returns: None - + """ pass @@ -46624,7 +46628,7 @@ Args: Returns: None - + """ pass @@ -46641,7 +46645,7 @@ Args: Returns: None - + """ pass @@ -46657,7 +46661,7 @@ Args: Returns: None - + """ pass @@ -46674,7 +46678,7 @@ Args: Returns: None - + """ pass @@ -46698,7 +46702,7 @@ Args: Returns: typing.Any - + """ pass @@ -46714,7 +46718,7 @@ Args: Returns: typing.Any - + """ pass @@ -46730,7 +46734,7 @@ Args: Returns: typing.Any - + """ pass @@ -46746,7 +46750,7 @@ Args: Returns: None - + """ pass @@ -46763,14 +46767,14 @@ Args: Returns: typing.Any - + """ pass def CommandToIndex(self,nID:'typing.Any') -> 'typing.Any': """ - Retrieve the zero-based index for the button associated with the + Retrieve the zero-based index for the button associated with the specified command identifier. @@ -46781,7 +46785,7 @@ Args: Returns: typing.Any - + """ pass @@ -46800,7 +46804,7 @@ Args: Returns: None - + """ pass @@ -46816,7 +46820,7 @@ Args: Returns: None - + """ pass @@ -46832,7 +46836,7 @@ Args: Returns: None - + """ pass @@ -46849,7 +46853,7 @@ Args: Returns: None - + """ pass @@ -46865,14 +46869,14 @@ Args: Returns: typing.Any - + """ pass def GetButton(self,nID:'typing.Any') -> 'typing.Any': """ - Retrieve information about the specified button in a + Retrieve information about the specified button in a toolbar control. @@ -46883,7 +46887,7 @@ Args: Returns: typing.Any - + """ pass @@ -46899,14 +46903,14 @@ Args: Returns: typing.Any - + """ pass def GetItemRect(self,nID:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': """ - Retrieve the bounding rectangle of a button in a + Retrieve the bounding rectangle of a button in a toolbar control. @@ -46917,7 +46921,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass @@ -46933,7 +46937,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass @@ -46950,7 +46954,7 @@ Args: Returns: None - + """ pass @@ -46967,7 +46971,7 @@ Args: Returns: None - + """ pass @@ -46984,7 +46988,7 @@ Args: Returns: typing.Any - + """ pass @@ -47000,7 +47004,7 @@ Args: Returns: typing.Any - + """ pass @@ -47016,7 +47020,7 @@ Args: Returns: typing.Any - + """ pass @@ -47032,14 +47036,14 @@ Args: Returns: typing.Any - + """ pass def IsButtonIndeterminate(self,nID:'typing.Any') -> 'typing.Any': """ - Determine whether the specified button in a toolbar control is + Determine whether the specified button in a toolbar control is indeterminate. @@ -47050,7 +47054,7 @@ Args: Returns: typing.Any - + """ pass @@ -47066,7 +47070,7 @@ Args: Returns: typing.Any - + """ pass @@ -47083,7 +47087,7 @@ Args: Returns: None - + """ pass @@ -47102,7 +47106,7 @@ Args: Returns: None - + """ pass @@ -47121,14 +47125,14 @@ Args: Returns: None - + """ pass def SetCmdID(self,nIndex:'typing.Any',nID:'typing.Any') -> 'None': """ - Set the command identifier which will be sent to the owner window when the + Set the command identifier which will be sent to the owner window when the specified button is pressed. @@ -47140,14 +47144,14 @@ Args: Returns: None - + """ pass def SetRows(self,nRows:'typing.Any',bLarger:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': """ - Ask the toolbar control to resize itself to the requested + Ask the toolbar control to resize itself to the requested number of rows. @@ -47159,7 +47163,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass @@ -47183,7 +47187,7 @@ Args: Returns: None - + """ pass @@ -47201,7 +47205,7 @@ Args: Returns: None - + """ pass @@ -47220,7 +47224,7 @@ Args: Returns: None - + """ pass @@ -47236,7 +47240,7 @@ Args: Returns: typing.Any - + """ pass @@ -47262,7 +47266,7 @@ Args: Returns: None - + """ pass @@ -47278,7 +47282,7 @@ Args: Returns: typing.Any - + """ pass @@ -47294,7 +47298,7 @@ Args: Returns: typing.Any - + """ pass @@ -47310,7 +47314,7 @@ Args: Returns: None - + """ pass @@ -47326,7 +47330,7 @@ Args: Returns: PyCImageList - + """ pass @@ -47343,7 +47347,7 @@ Args: Returns: typing.Any - + """ pass @@ -47360,7 +47364,7 @@ Args: Returns: typing.Any - + """ pass @@ -47376,7 +47380,7 @@ Args: Returns: typing.Any - + """ pass @@ -47392,7 +47396,7 @@ Args: Returns: typing.Any - + """ pass @@ -47408,7 +47412,7 @@ Args: Returns: typing.Any - + """ pass @@ -47424,7 +47428,7 @@ Args: Returns: typing.Any - + """ pass @@ -47440,7 +47444,7 @@ Args: Returns: typing.Any - + """ pass @@ -47456,7 +47460,7 @@ Args: Returns: typing.Any - + """ pass @@ -47472,7 +47476,7 @@ Args: Returns: typing.Any - + """ pass @@ -47488,7 +47492,7 @@ Args: Returns: typing.Any - + """ pass @@ -47504,7 +47508,7 @@ Args: Returns: typing.Any - + """ pass @@ -47520,7 +47524,7 @@ Args: Returns: typing.Any - + """ pass @@ -47536,7 +47540,7 @@ Args: Returns: typing.Any - + """ pass @@ -47553,7 +47557,7 @@ Args: Returns: TV_ITEM - + """ pass @@ -47569,7 +47573,7 @@ Args: Returns: typing.Any - + """ pass @@ -47586,7 +47590,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -47604,7 +47608,7 @@ Args: Returns: None - + """ pass @@ -47620,7 +47624,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any] - + """ pass @@ -47638,7 +47642,7 @@ Args: Returns: None - + """ pass @@ -47655,7 +47659,7 @@ Args: Returns: typing.Any - + """ pass @@ -47671,7 +47675,7 @@ Args: Returns: typing.Any - + """ pass @@ -47687,7 +47691,7 @@ Args: Returns: typing.Any - + """ pass @@ -47704,7 +47708,7 @@ Args: Returns: typing.Any - + """ pass @@ -47721,14 +47725,14 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass def GetEditControl(self,) -> 'PyCEdit': """ - Retrieves the handle of the edit control used to edit the specified + Retrieves the handle of the edit control used to edit the specified tree view item. @@ -47739,14 +47743,14 @@ Args: Returns: PyCEdit - + """ pass def GetVisibleCount(self,) -> 'typing.Any': """ - Retrieves the number of visible tree items associated with a tree view + Retrieves the number of visible tree items associated with a tree view control. @@ -47757,7 +47761,7 @@ Args: Returns: typing.Any - + """ pass @@ -47792,7 +47796,7 @@ Args: Returns: typing.Any - + """ pass @@ -47808,7 +47812,7 @@ Args: Returns: None - + """ pass @@ -47824,7 +47828,7 @@ Args: Returns: typing.Any - + """ pass @@ -47841,7 +47845,7 @@ Args: Returns: None - + """ pass @@ -47858,7 +47862,7 @@ Args: Returns: None - + """ pass @@ -47874,7 +47878,7 @@ Args: Returns: None - + """ pass @@ -47890,7 +47894,7 @@ Args: Returns: None - + """ pass @@ -47906,7 +47910,7 @@ Args: Returns: None - + """ pass @@ -47922,7 +47926,7 @@ Args: Returns: PyCEdit - + """ pass @@ -47938,7 +47942,7 @@ Args: Returns: PyCImageList - + """ pass @@ -47954,7 +47958,7 @@ Args: Returns: None - + """ pass @@ -47970,7 +47974,7 @@ Args: Returns: typing.Any - + """ pass @@ -47985,7 +47989,7 @@ Args: Returns: - typing.Tuple[typing.Any, typing.Any]:The point to test.Return ValueThe result is a tuple of (flags, hItem). + typing.Tuple[typing.Any, typing.Any]:The point to test.Return ValueThe result is a tuple of (flags, hItem). flags may be a combination of the following values: @@ -48011,7 +48015,7 @@ commctrl.TVHT_ONITEMSTATEICONOn the state icon for a tree view item that is in a commctrl.TVHT_TOLEFTTo the left of the client area. commctrl.TVHT_TORIGHTTo the right of the client area. - + """ pass @@ -48034,7 +48038,7 @@ Args: Returns: typing.Any - + """ pass @@ -48050,7 +48054,7 @@ Args: Returns: PyCTreeCtrl - + """ pass @@ -48067,7 +48071,7 @@ Args: Returns: None - + """ pass @@ -48093,7 +48097,7 @@ Args: Returns: None - + """ pass @@ -48109,7 +48113,7 @@ Args: Returns: PyCDocument - + """ pass @@ -48127,7 +48131,7 @@ Args: Returns: typing.Any - + """ pass @@ -48143,7 +48147,7 @@ Args: Returns: None - + """ pass @@ -48161,7 +48165,7 @@ Args: Returns: typing.Any - + """ pass @@ -48177,7 +48181,7 @@ Args: Returns: typing.Any - + """ pass @@ -48193,7 +48197,7 @@ Args: Returns: None - + """ pass @@ -48209,7 +48213,7 @@ Args: Returns: typing.Any - + """ pass @@ -48225,7 +48229,7 @@ Args: Returns: None - + """ pass @@ -48241,7 +48245,7 @@ Args: Returns: None - + """ pass @@ -48264,7 +48268,7 @@ Args: Returns: None - + """ pass @@ -48280,7 +48284,7 @@ Args: Returns: PyCDocument - + """ pass @@ -48296,7 +48300,7 @@ Args: Returns: typing.List[typing.Any] - + """ pass @@ -48312,7 +48316,7 @@ Args: Returns: None - + """ pass @@ -48328,7 +48332,7 @@ Args: Returns: typing.Any - + """ pass @@ -48344,7 +48348,7 @@ Args: Returns: typing.Any - + """ pass @@ -48360,7 +48364,7 @@ Args: Returns: typing.Any - + """ pass @@ -48376,7 +48380,7 @@ Args: Returns: typing.Any - + """ pass @@ -48392,7 +48396,7 @@ Args: Returns: typing.Any - + """ pass @@ -48408,7 +48412,7 @@ Args: Returns: None - + """ pass @@ -48424,7 +48428,7 @@ Args: Returns: None - + """ pass @@ -48440,7 +48444,7 @@ Args: Returns: None - + """ pass @@ -48456,7 +48460,7 @@ Args: Returns: None - + """ pass @@ -48472,14 +48476,14 @@ Args: Returns: typing.Any - + """ pass def IsInproc(self,) -> 'typing.Any': """ - Returns a flag to indicate if the created CWinApp was in the DLL, or an external + Returns a flag to indicate if the created CWinApp was in the DLL, or an external EXE. @@ -48490,7 +48494,7 @@ Args: Returns: typing.Any - + """ pass @@ -48513,7 +48517,7 @@ Args: Returns: None - + """ pass @@ -48529,7 +48533,7 @@ Args: Returns: None - + """ pass @@ -48545,7 +48549,7 @@ Args: Returns: None - + """ pass @@ -48561,7 +48565,7 @@ Args: Returns: typing.Any - + """ pass @@ -48577,7 +48581,7 @@ Args: Returns: None - + """ pass @@ -48593,7 +48597,7 @@ Args: Returns: None - + """ pass @@ -48607,7 +48611,7 @@ class PyCWnd(object): def ActivateFrame(self,cmdShow:'typing.Any') -> 'None': """ - Searches upwards for a parent window which has + Searches upwards for a parent window which has a frame, and activates it. @@ -48618,7 +48622,7 @@ Args: Returns: None - + """ pass @@ -48634,7 +48638,7 @@ Args: Returns: None - + """ pass @@ -48655,16 +48659,16 @@ PyCDC, PAINTSTRUCT = BeginPaint()Prepares a window for painting Return ValueYou must pass the PAINTSTRUCT param to the PyCWnd::EndPaint method. - + """ pass def CalcWindowRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',nAdjustType:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': """ - Computes the size of the window rectangle based on the desired client + Computes the size of the window rectangle based on the desired client -rectangle size. The resulting size can then be used as the initial +rectangle size. The resulting size can then be used as the initial size for the window object. @@ -48676,7 +48680,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass @@ -48692,14 +48696,14 @@ Args: Returns: None - + """ pass def CheckRadioButton(self,idFirst:'typing.Any',idLast:'typing.Any',idCheck:'typing.Any') -> 'None': """ - Selects the specified radio button, and clears + Selects the specified radio button, and clears all others in the group. @@ -48712,7 +48716,7 @@ Args: Returns: None - + """ pass @@ -48730,14 +48734,14 @@ Args: Returns: PyCWnd - + """ pass def ClientToScreen(self,point:'typing.Tuple[typing.Any, typing.Any]',rect:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any]': """ - Converts the client coordinates of a given point on the display + Converts the client coordinates of a given point on the display to screen coordinates. @@ -48749,7 +48753,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass @@ -48771,7 +48775,7 @@ Args: Returns: None - + """ pass @@ -48795,7 +48799,7 @@ Args: Returns: None - + """ pass @@ -48813,7 +48817,7 @@ Args: Returns: typing.Any - + """ pass @@ -48829,7 +48833,7 @@ Args: Returns: None - + """ pass @@ -48848,7 +48852,7 @@ Args: Returns: None - + """ pass @@ -48864,7 +48868,7 @@ Args: Returns: None - + """ pass @@ -48880,7 +48884,7 @@ Args: Returns: str - + """ pass @@ -48896,7 +48900,7 @@ Args: Returns: str - + """ pass @@ -48912,7 +48916,7 @@ Args: Returns: None - + """ pass @@ -48928,7 +48932,7 @@ Args: Returns: None - + """ pass @@ -48946,7 +48950,7 @@ Returns: typing.Any:CWnd::EnableWindow Return ValueReturns the state before the EnableWindow member function was called - + """ pass @@ -48962,7 +48966,7 @@ Args: Returns: None - + """ pass @@ -48978,7 +48982,7 @@ Args: Returns: None - + """ pass @@ -48995,14 +48999,14 @@ Args: Returns: typing.Any - + """ pass def GetClientRect(self,) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': """ - Returns the client coordinates of the window. left and top + Returns the client coordinates of the window. left and top will be zero. @@ -49013,7 +49017,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass @@ -49032,7 +49036,7 @@ Returns: PyCDC = GetDC()Gets the windows current DC object. Return ValueThe result is a PyCDC, or a win32ui.error exception is raised. - + """ pass @@ -49048,7 +49052,7 @@ Args: Returns: PyCDC - + """ pass @@ -49064,7 +49068,7 @@ Args: Returns: typing.Any - + """ pass @@ -49082,7 +49086,7 @@ Returns: PyCWnd:CWnd::GetDlgItem Return ValueThe result is a PyCWnd (or derived) object, or a win32ui.error exception is raised. - + """ pass @@ -49101,7 +49105,7 @@ Returns: typing.Any:CWnd::GetDlgItemInt Return ValueIf the value can not be converted, a ValueError is raised. - + """ pass @@ -49117,7 +49121,7 @@ Args: Returns: str - + """ pass @@ -49135,7 +49139,7 @@ Returns: PyCWnd:CWnd::GetLastActivePopup Return ValueThe result is a PyCWnd object, or None if no Window can be found. - + """ pass @@ -49155,7 +49159,7 @@ Return ValueThe result is a PyMenu object, or an exception is thrown. - + """ pass @@ -49173,7 +49177,7 @@ Returns: PyCWnd:CWnd::GetParent Return ValueThe result is a PyCWnd object, or None if no Window can be found. - + """ pass @@ -49191,7 +49195,7 @@ Returns: PyCWnd:CWnd::GetParentFrame Return ValueThe result is a PyCWnd object, or None if no Window can be found. - + """ pass @@ -49207,7 +49211,7 @@ Args: Returns: typing.Any - + """ pass @@ -49224,7 +49228,7 @@ Args: Returns: typing.Any - + """ pass @@ -49240,7 +49244,7 @@ Args: Returns: typing.Any - + """ pass @@ -49256,7 +49260,7 @@ Args: Returns: typing.Any - + """ pass @@ -49272,7 +49276,7 @@ Args: Returns: typing.Any - + """ pass @@ -49288,7 +49292,7 @@ Args: Returns: PyCMenu - + """ pass @@ -49306,7 +49310,7 @@ Returns: PyCWnd:CWnd::GetTopLevelFrame Return ValueThe result is a PyCWnd object, or None if no Window can be found. - + """ pass @@ -49324,7 +49328,7 @@ Returns: PyCWnd:CWnd::GetTopLevelOwner Return ValueThe result is a PyCWnd object, or None if no Window can be found. - + """ pass @@ -49342,7 +49346,7 @@ Returns: PyCWnd:CWnd::GetTopLevelParent Return ValueThe result is a PyCWnd object, or None if no Window can be found. - + """ pass @@ -49360,7 +49364,7 @@ Returns: PyCWnd:CWnd::GetTopWindow Return ValueIf no child windows exist, the value is None. - + """ pass @@ -49378,7 +49382,7 @@ Returns: PyCWnd:CWnd::GetWindow Return ValueThe result is a PyCWnd or None if no Window can be found. - + """ pass @@ -49394,7 +49398,7 @@ Args: Returns: PyCDC - + """ pass @@ -49410,7 +49414,7 @@ Args: Returns: typing.Any:CWnd::GetWindowPlacement -Return ValueThe result is a tuple of +Return ValueThe result is a tuple of (flags, showCmd, (minposX, minposY), (maxposX, maxposY), (normalposX, normalposY)) @@ -49429,14 +49433,14 @@ minposSpecifies the coordinates of the window's upper-left corner when the windo maxposSpecifies the coordinates of the window's upper-left corner when the window is maximized. normalposSpecifies the window's coordinates when the window is in the restored position. - + """ pass def GetWindowRect(self,) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': """ - Returns the screen coordinates of the windows upper left + Returns the screen coordinates of the windows upper left corner @@ -49447,7 +49451,7 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - + """ pass @@ -49463,7 +49467,7 @@ Args: Returns: str - + """ pass @@ -49479,7 +49483,7 @@ Args: Returns: None - + """ pass @@ -49495,7 +49499,7 @@ Args: Returns: None - + """ pass @@ -49511,26 +49515,26 @@ Args: Returns: - typing.Any:The ID for the keystroke to be handled. + typing.Any:The ID for the keystroke to be handled. This may be an ascii code, or a virtual key code.Comments -The handler object passed will be called as the application receives WM_CHAR message for the specified +The handler object passed will be called as the application receives WM_CHAR message for the specified -character code. The handler will be called with 2 arguments +character code. The handler will be called with 2 arguments -The handler object (as per all hook functions) +The handler object (as per all hook functions) -The keystroke being handled. +The keystroke being handled. -If the handler returns TRUE, then the keystroke will be passed on to the +If the handler returns TRUE, then the keystroke will be passed on to the -default handler, otherwise the keystroke will be consumed. +default handler, otherwise the keystroke will be consumed. Note: This handler will not be called if a PyCWnd::HookAllKeyStrokes hook is in place. Return ValueThe return value is the previous handler, or None. - + """ pass @@ -49548,15 +49552,15 @@ Returns: typing.Any:The ID of the message to be handled.Comments -The handler object passed will be called as the application receives messages with the specified ID. +The handler object passed will be called as the application receives messages with the specified ID. -Note that it is not possible for PythonWin to consume a message - it is always passed on to the default handler. +Note that it is not possible for PythonWin to consume a message - it is always passed on to the default handler. -The handler will be called with 2 arguments +The handler will be called with 2 arguments -The handler object (as per all hook functions). +The handler object (as per all hook functions). -A tuple representing the message. +A tuple representing the message. The message tuple is in the following format: Items[0] int : hwnd @@ -49573,7 +49577,7 @@ The time the message was posted. The point where the mouse was when the message was posted. Return ValueThe return value is the previous handler, or None. - + """ pass @@ -49590,7 +49594,7 @@ Args: Returns: None - + """ pass @@ -49607,7 +49611,7 @@ Args: Returns: None - + """ pass @@ -49623,7 +49627,7 @@ Args: Returns: typing.Any - + """ pass @@ -49639,7 +49643,7 @@ Args: Returns: typing.Any - + """ pass @@ -49655,7 +49659,7 @@ Args: Returns: typing.Any - + """ pass @@ -49671,7 +49675,7 @@ Args: Returns: typing.Any - + """ pass @@ -49687,7 +49691,7 @@ Args: Returns: typing.Any - + """ pass @@ -49703,7 +49707,7 @@ Args: Returns: typing.Any - + """ pass @@ -49719,7 +49723,7 @@ Args: Returns: typing.Any - + """ pass @@ -49735,14 +49739,14 @@ Args: Returns: None - + """ pass def MapWindowPoints(self,wnd:'PyCWnd',points:'typing.List[typing.Tuple[typing.Any, typing.Any]]') -> 'None': """ - Converts (maps) a set of points from the coordinate space of a window to the + Converts (maps) a set of points from the coordinate space of a window to the coordinate space of another window. @@ -49753,11 +49757,11 @@ Args: Returns: - None:The points to mapReturn ValueA list of the mapped points from the coordinate space of the CWnd to the coordinate space of another + None:The points to mapReturn ValueA list of the mapped points from the coordinate space of the CWnd to the coordinate space of another window. - + """ pass @@ -49773,7 +49777,7 @@ Args: Returns: typing.Any - + """ pass @@ -49793,7 +49797,7 @@ Returns: None:CWnd::MessageBox Return ValueAn integer identifying the button pressed to dismiss the dialog. - + """ pass @@ -49811,11 +49815,11 @@ Args: Returns: typing.Any:CWnd::ModifyStyle -Return ValueThe result is true if the style was changed, or false if the style +Return ValueThe result is true if the style was changed, or false if the style is already the same as requested and no change was made. - + """ pass @@ -49833,11 +49837,11 @@ Args: Returns: typing.Any:CWnd::ModifyStyleEx -Return ValueThe result is true if the style was changed, or false if the style +Return ValueThe result is true if the style was changed, or false if the style is already the same as requested and no change was made. - + """ pass @@ -49854,7 +49858,7 @@ Args: Returns: None - + """ pass @@ -49870,7 +49874,7 @@ Args: Returns: typing.Any - + """ pass @@ -49888,7 +49892,7 @@ Args: Returns: typing.Any - + """ pass @@ -49904,7 +49908,7 @@ Args: Returns: typing.Any - + """ pass @@ -49920,7 +49924,7 @@ Args: Returns: typing.Any - + """ pass @@ -49936,7 +49940,7 @@ Args: Returns: typing.Any - + """ pass @@ -49952,7 +49956,7 @@ Args: Returns: typing.Any - + """ pass @@ -49968,7 +49972,7 @@ Args: Returns: typing.Any - + """ pass @@ -49986,7 +49990,7 @@ Args: Returns: typing.Any - + """ pass @@ -50004,7 +50008,7 @@ Args: Returns: typing.Any - + """ pass @@ -50022,13 +50026,13 @@ Args: Returns: typing.Tuple[typing.Any, typing.Any]:CWnd::OnWndMsg -Return ValueThe return value is a tuple of (int, int), being the +Return ValueThe return value is a tuple of (int, int), being the -return value from the MFC function call, and the value of the +return value from the MFC function call, and the value of the lResult param. Please see the MFC documentation for more details. - + """ pass @@ -50044,7 +50048,7 @@ Args: Returns: typing.Any - + """ pass @@ -50061,7 +50065,7 @@ Args: Returns: None - + """ pass @@ -50079,7 +50083,7 @@ Args: Returns: None - + """ pass @@ -50095,7 +50099,7 @@ Args: Returns: None - + """ pass @@ -50111,16 +50115,16 @@ Args: Returns: None - + """ pass def RepositionBars(self,idFirst:'typing.Any',idLast:'typing.Any',idLeftOver:'typing.Any') -> 'None': """ - Repositions the windows control bars.( UINT nIDFirst, UINT nIDLast, UINT + Repositions the windows control bars.( UINT nIDFirst, UINT nIDLast, UINT -nIDLeftOver, UINT nFlag = CWnd::reposDefault, LPRECT lpRectParam = NULL, LPCRECT lpRectClient = NULL, BOOL bStretch = +nIDLeftOver, UINT nFlag = CWnd::reposDefault, LPRECT lpRectParam = NULL, LPCRECT lpRectClient = NULL, BOOL bStretch = TRUE ); @@ -50133,7 +50137,7 @@ Args: Returns: None - + """ pass @@ -50149,7 +50153,7 @@ Args: Returns: typing.Any - + """ pass @@ -50167,7 +50171,7 @@ Args: Returns: None - + """ pass @@ -50186,7 +50190,7 @@ Args: Returns: None - + """ pass @@ -50206,7 +50210,7 @@ Args: Returns: None - + """ pass @@ -50225,7 +50229,7 @@ Returns: PyCWnd = SetActiveWindow()Sets the window active. Returns the previously active window, or None. Return ValueThe result is the previous window with focus, or None. - + """ pass @@ -50241,7 +50245,7 @@ Args: Returns: None - + """ pass @@ -50259,14 +50263,14 @@ Args: Returns: None - + """ pass def ScreenToClient(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any]',pnt:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any]': """ - Converts the screen coordinates of a given point + Converts the screen coordinates of a given point or rectangle on the display to client coordinates. @@ -50280,14 +50284,14 @@ Returns: typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any]:CWnd::ScreenToClient Return ValueThe result is the same size as the input argument. - + """ pass def SetCapture(self,) -> 'None': """ - Causes all subsequent mouse input to be sent to the window object regardless of the + Causes all subsequent mouse input to be sent to the window object regardless of the position of the cursor. @@ -50298,7 +50302,7 @@ Args: Returns: None - + """ pass @@ -50315,7 +50319,7 @@ Args: Returns: None - + """ pass @@ -50331,7 +50335,7 @@ Args: Returns: None - + """ pass @@ -50348,7 +50352,7 @@ Args: Returns: None - + """ pass @@ -50364,7 +50368,7 @@ Args: Returns: typing.Any - + """ pass @@ -50380,7 +50384,7 @@ Args: Returns: None - + """ pass @@ -50396,7 +50400,7 @@ Args: Returns: None - + """ pass @@ -50414,7 +50418,7 @@ Args: Returns: typing.Any - + """ pass @@ -50432,7 +50436,7 @@ Args: Returns: typing.Any - + """ pass @@ -50449,7 +50453,7 @@ Args: Returns: typing.Any - + """ pass @@ -50465,7 +50469,7 @@ Args: Returns: None - + """ pass @@ -50481,7 +50485,7 @@ Args: Returns: None - + """ pass @@ -50497,14 +50501,14 @@ Args: Returns: None - + """ pass def ShowScrollBar(self,nBar:'typing.Any',bShow:'typing.Any'=1) -> 'None': """ - Shows or hides a scroll bar. + Shows or hides a scroll bar. An application should not call ShowScrollBar to hide a scroll bar while processing a scroll-bar notification message. @@ -50516,7 +50520,7 @@ Args: Returns: None - + """ pass @@ -50534,7 +50538,7 @@ Returns: typing.Any:CWnd::ShowWindow Return ValueReturns TRUE is the window was previously visible. - + """ pass @@ -50550,16 +50554,16 @@ Args: Returns: None - + """ pass def UpdateData(self,bSaveAndValidate:'typing.Any'=1) -> 'typing.Any': """ - Initialises data in a dialog box, or to retrieves and validates dialog data. + Initialises data in a dialog box, or to retrieves and validates dialog data. -Returns nonzero if the operation is successful; otherwise 0. If bSaveAndValidate is TRUE, then a return value of +Returns nonzero if the operation is successful; otherwise 0. If bSaveAndValidate is TRUE, then a return value of nonzero means that the data is successfully validated. @@ -50570,7 +50574,7 @@ Args: Returns: typing.Any - + """ pass @@ -50587,14 +50591,14 @@ Args: Returns: typing.Any - + """ pass def UpdateWindow(self,) -> 'None': """ - Updates a window. This forces a paint message to be sent to the window, if any part + Updates a window. This forces a paint message to be sent to the window, if any part of the window is marked as invalid. @@ -50605,7 +50609,7 @@ Args: Returns: None - + """ pass @@ -50629,7 +50633,7 @@ Args: Returns: None - + """ pass @@ -50645,7 +50649,7 @@ Args: Returns: None - + """ pass @@ -50661,7 +50665,7 @@ Args: Returns: None - + """ pass @@ -50677,7 +50681,7 @@ Args: Returns: None - + """ pass @@ -50693,7 +50697,7 @@ Args: Returns: None - + """ pass @@ -50716,7 +50720,7 @@ Args: Returns: None - + """ pass @@ -50733,7 +50737,7 @@ Args: Returns: None - + """ pass @@ -50749,7 +50753,7 @@ Args: Returns: None - + """ pass @@ -50765,7 +50769,7 @@ Args: Returns: typing.Any - + """ pass @@ -50781,7 +50785,7 @@ Args: Returns: None - + """ pass @@ -50804,7 +50808,7 @@ Args: Returns: None - + """ pass @@ -50827,7 +50831,7 @@ Args: Returns: None - + """ pass @@ -50843,7 +50847,7 @@ Args: Returns: None - + """ pass @@ -50866,7 +50870,7 @@ Args: Returns: str - + """ pass @@ -50882,7 +50886,7 @@ Args: Returns: None - + """ pass @@ -50902,7 +50906,7 @@ class TV_ITEM(object): class EXTENSION_CONTROL_BLOCK(object): - """A python representation of an ISAPI + """A python representation of an ISAPI EXTENSION_CONTROL_BLOCK.""" @@ -50996,7 +51000,7 @@ Returns: typing.Any: Return Valuethe result is the number of bytes written. - + """ pass @@ -51012,15 +51016,15 @@ Args: Returns: - str:If specified, the function will return this + str:If specified, the function will return this -value instead of raising an error if the variable could not be fetched.Return ValueThe result is a string object, unless the server variable name +value instead of raising an error if the variable could not be fetched.Return ValueThe result is a string object, unless the server variable name -begins with 'UNICODE_', in which case it is a unicode object - see the +begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. - + """ pass @@ -51036,14 +51040,14 @@ Args: Returns: str - + """ pass def SendResponseHeaders(self,reply:'str',headers:'str',keepAlive:'typing.Any'=False) -> 'None': """ - Calls ServerSupportFunction with + Calls ServerSupportFunction with HSE_REQ_SEND_RESPONSE_HEADER_EX @@ -51056,7 +51060,7 @@ Args: Returns: None - + """ pass @@ -51072,7 +51076,7 @@ Args: Returns: None - + """ pass @@ -51096,7 +51100,7 @@ Args: Returns: typing.Any - + """ pass @@ -51112,7 +51116,7 @@ Args: Returns: None - + """ pass @@ -51128,7 +51132,7 @@ Args: Returns: None - + """ pass @@ -51144,7 +51148,7 @@ Args: Returns: None - + """ pass @@ -51160,14 +51164,14 @@ Args: Returns: None - + """ pass def GetAnonymousToken(self,metabase_path:'typing.Union[str, typing.Any]') -> 'typing.Any': """ - Calls ServerSupportFunction with HSE_REQ_GET_ANONYMOUS_TOKEN + Calls ServerSupportFunction with HSE_REQ_GET_ANONYMOUS_TOKEN or HSE_REQ_GET_UNICODE_ANONYMOUS_TOKEN @@ -51178,14 +51182,14 @@ Args: Returns: typing.Any - + """ pass def GetImpersonationToken(self,) -> 'typing.Any': """ - Calls ServerSupportFunction with + Calls ServerSupportFunction with HSE_REQ_GET_IMPERSONATION_TOKEN @@ -51196,7 +51200,7 @@ Args: Returns: typing.Any - + """ pass @@ -51212,7 +51216,7 @@ Args: Returns: typing.Any - + """ pass @@ -51233,7 +51237,7 @@ Args: Returns: typing.Any - + """ pass @@ -51251,14 +51255,14 @@ Returns: typing.Any:Search for HSE_EXEC_URL_STATUS at msdn, google or google groups. Return ValueThe result of a tuple of 3 integers - (uHttpStatusCode, uHttpSubStatus, dwWin32Error) - + """ pass def IOCompletion(self,func:'typing.Any',arg:'typing.Any'=None) -> 'typing.Any': """ - Set a callback that will be used for handling asynchronous I/O + Set a callback that will be used for handling asynchronous I/O operations. @@ -51270,7 +51274,7 @@ Args: Returns: typing.Any - + """ pass @@ -51286,7 +51290,7 @@ Args: Returns: typing.Any - + """ pass @@ -51306,14 +51310,14 @@ Returns: typing.Any:The error code returned.Comments -This is not a function you can call, it describes the signature of +This is not a function you can call, it describes the signature of -the callback function supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion +the callback function supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion function. Return ValueThe result of this function is ignored. - + """ pass @@ -51332,7 +51336,7 @@ class HSE_VERSION_INFO(object): class HTTP_FILTER_AUTHENT(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_AUTHENT structure.""" @@ -51353,7 +51357,7 @@ HTTP_FILTER_AUTHENT structure.""" class HTTP_FILTER_CONTEXT(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_CONTEXT structure.""" @@ -51387,9 +51391,9 @@ HTTP_FILTER_CONTEXT structure.""" def GetData(self,) -> 'typing.Any': """ - Obtains the data passed to + Obtains the data passed to -The HttpFilterProc function. This is not techinally part of the +The HttpFilterProc function. This is not techinally part of the HTTP_FILTER_CONTEXT structure, but packaged here for convenience. @@ -51401,9 +51405,9 @@ Returns: typing.Any:HTTP_FILTER_CONTEXT.GetData -object = GetData()Obtains the data passed to +object = GetData()Obtains the data passed to -The HttpFilterProc function. This is not techinally part of the +The HttpFilterProc function. This is not techinally part of the HTTP_FILTER_CONTEXT structure, but packaged here for convenience. Return ValueThe result depends on the value of HTTP_FILTER_CONTEXT::NotificationType @@ -51425,7 +51429,7 @@ SF_NOTIFY_SEND_RAW_DATAHTTP_FILTER_RAW_DATA SF_NOTIFY_READ_RAW_DATAHTTP_FILTER_RAW_DATA SF_NOTIFY_AUTHENTICATIONHTTP_FILTER_AUTHENT - + """ pass @@ -51441,15 +51445,15 @@ Args: Returns: - str:If specified, the function will return this + str:If specified, the function will return this -value instead of raising an error if the variable could not be fetched.Return ValueThe result is a string object, unless the server variable name +value instead of raising an error if the variable could not be fetched.Return ValueThe result is a string object, unless the server variable name -begins with 'UNICODE_', in which case it is a unicode object - see the +begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. - + """ pass @@ -51466,7 +51470,7 @@ Args: Returns: None - + """ pass @@ -51483,7 +51487,7 @@ Args: Returns: None - + """ pass @@ -51500,7 +51504,7 @@ Args: Returns: None - + """ pass @@ -51516,13 +51520,13 @@ Args: Returns: None - + """ pass class HTTP_FILTER_LOG(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_LOG structure.""" @@ -51573,7 +51577,7 @@ HTTP_FILTER_LOG structure.""" class HTTP_FILTER_PREPROC_HEADERS(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_PREPROC_HEADERS structure.""" @@ -51593,7 +51597,7 @@ Args: Returns: str - + """ pass @@ -51610,7 +51614,7 @@ Args: Returns: None - + """ pass @@ -51626,13 +51630,13 @@ Args: Returns: None - + """ pass class HTTP_FILTER_RAW_DATA(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_RAW_DATA structure.""" @@ -51647,7 +51651,7 @@ HTTP_FILTER_RAW_DATA structure.""" class HTTP_FILTER_URL_MAP(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_URL_MAP structure.""" @@ -51668,7 +51672,7 @@ HTTP_FILTER_URL_MAP structure.""" class HTTP_FILTER_VERSION(object): - """A Python interface to the ISAPI HTTP_FILTER_VERSION + """A Python interface to the ISAPI HTTP_FILTER_VERSION structure."""